mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-22 02:18:26 +00:00
Website redesign
This commit is contained in:
@ -4,11 +4,14 @@ description = "Contains some ADRs, which are internal notes on decisions made."
|
||||
weight = 300
|
||||
sort_by = "weight"
|
||||
insert_anchor_links = "right"
|
||||
template = "pages.html"
|
||||
template = "docs.html"
|
||||
page_template = "docs.html"
|
||||
[extra]
|
||||
mktoc = true
|
||||
page_list = true
|
||||
+++
|
||||
|
||||
# ADR
|
||||
|
||||
This contains a list of ADRs, most of them are from very early. It
|
||||
often just contains notes that could go nowhere else, but still should
|
||||
be captured.
|
||||
|
@ -3,6 +3,7 @@ title = "Building Docspell"
|
||||
weight = 0
|
||||
+++
|
||||
|
||||
# Building
|
||||
|
||||
You must install [sbt](https://scala-sbt.org),
|
||||
[nodejs](https://www.npmjs.com/get-npm) (for the `npm` command) and
|
||||
|
@ -3,7 +3,9 @@ title = "Tips & Setup"
|
||||
weight = 20
|
||||
+++
|
||||
|
||||
# Starting Servers with `reStart`
|
||||
# Setup / Tips
|
||||
|
||||
## Starting Servers with `reStart`
|
||||
|
||||
When developing, it's very convenient to use the [revolver sbt
|
||||
plugin](https://github.com/spray/sbt-revolver). Start the sbt console
|
||||
@ -29,7 +31,7 @@ sbt:docspell-root> reStart
|
||||
```
|
||||
|
||||
|
||||
# Custom config file
|
||||
## Custom config file
|
||||
|
||||
The sbt build is setup such that a file `dev.conf` in the directory
|
||||
`local` (at root of the source tree) is picked up as config file, if
|
||||
|
@ -3,6 +3,7 @@ title = "Translating Web-UI"
|
||||
weight = 10
|
||||
+++
|
||||
|
||||
# UI Translation
|
||||
|
||||
Help with translating the web-ui is greatly appreciated. I can only
|
||||
provide translations for English and German, and these may be wrong -
|
||||
@ -16,7 +17,7 @@ messages.
|
||||
|
||||
This guide assumes no knowledge about Elm at all.
|
||||
|
||||
# TL;DR
|
||||
## TL;DR
|
||||
|
||||
If you are already familiar with Elm, here is the TL;DR:
|
||||
|
||||
@ -92,7 +93,7 @@ sbt:docspell-root> make
|
||||
This will take a while, you need to wait until this is finished.
|
||||
|
||||
|
||||
## Start the application
|
||||
### Start the application
|
||||
|
||||
If sbt is not started, start sbt from within the source root. Also
|
||||
export the `DOCSPELL_ENV` variable *before* starting sbt:
|
||||
|
Reference in New Issue
Block a user