dcrdocs
is source code for the Decred project documentation.
dcrdocs
is built with MkDocs - a documentation toolkit written in Python.
In order to develop on dcrdocs
you will need Python installed on your system. Version 3.7 is recommended because this is the version used by the live site, however MkDocs does also support versions 2.7, 3.4, 3.5 and 3.6.
You can verify your installation of Python by checking the output from these two commands:
$ python --version
Python 3.7.0
$ pip --version
pip 18.0
To install MkDocs and all of the other Python libraries required by dcrdocs
:
$ pip install --user -r requirements.txt
This repo contains a single configuration file named mkdocs.yml
, and a folder named docs
that will contain the documentation source files. MkDocs comes with a built-in dev-server that lets you preview the documentation as you work on it. Make sure you are in the same directory as the mkdocs.yml
configuration file, and then start the server by running the mkdocs serve
command:
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 160402 15:50:43 server:271] Serving on http:https://127.0.0.1:8000
[I 160402 15:50:43 handlers:58] Start watching changes
[I 160402 15:50:43 handlers:60] Start detecting changes
Open up http:https://127.0.0.1:8000 in your browser, and you will see the documentation home page being displayed. The dev-server also supports auto-reloading, and will rebuild your documentation whenever anything in the configuration file or the documentation directory changes.
To deploy dcrdocs
, first build the documentation:
$ ./build_docs.sh
This will build the documentation into a new directory named site
.
The version of dcrdocs
that you just built only uses static files which are all contained within the site/
directory, so this directory can be hosted using almost any web server software.
dcrdocs
can also be built and hosted in a Docker container. Build the container using:
$ ./build_docker.sh
The container can then be run with:
$ docker run -d --rm -p <local port>:80 decred/dcrdocs:latest
advanced/manual-cli-install.md
wallets/cli/dcrd-and-dcrwallet-cli-arguments.md
wallets/cli/dcrctl-rpc-commands.md
wallets/cli/cli-installation.md
user-guides/decrediton-setup.md
wallets/decrediton/using-decrediton.md
mining/proof-of-work/pool-mining.md
advanced/using-testnet.md
To get help with dcrdocs
please create a GitHub issue or the join the Decred community using your preferred chat platform.