Repository files navigation

dcrdocs is source code for theDecred project documentation.

dcrdocs is built withMkDocs - a documentation toolkit written in Python.

In order to develop ondcrdocs you will needPythoninstalled on your system.Version 3.9 is recommended because this is the version used by the live site,however MkDocs does also support versions 3.6 and later.Python 2 is not supported.

You can verify your installation of Python by checking the output from these twocommands:

$ python --versionPython 3.9.5$ pip --versionpip 21.1.2

To install MkDocs and all of the other Python libraries required bydcrdocs:

$ pip install mkdocs&& pip install --user -r requirements.txt

This repo contains a single configuration file namedmkdocs.yml, and a folder nameddocs 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 themkdocs.yml configuration file, and then start the server by running themkdocs serve command:

$ mkdocs serveINFO     -  Building documentation...INFO     -  Cleaning site directoryINFO     -  Documentation builtin 9.09 secondsINFO     -  [13:26:55] Serving on http://127.0.0.1:8000/

If you are using Windows, you may need to inform python to search sys.path for the mkdocs module:

$ python -m mkdocs serveINFO     -  Building documentation...INFO     -  Cleaning site directoryINFO     -  Documentation builtin 9.09 secondsINFO     -  [13:26:55] Serving on http://127.0.0.1:8000/

Open uphttp://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.

In general, stick to standard Markdown formatting. However, these docs useMaterial for Mkdocs, so consult their documentation if you need additional formatting tools.

To deploydcrdocs, first build the documentation:

$ ./bin/build_docs.sh

This will build the documentation into a new directory namedsite.

The version ofdcrdocs that you just built only uses static files which are all contained within thesite/ directory, so this directory can be hosted using almost any web server software.

dcrdocs can also be built and hosted in aDocker container. Build the container using:

$ ./bin/build.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
• advanced/solo-proof-of-stake-voting.md
• advanced/verifying-binaries.md
• advanced/secure-cold-wallet-setup.md

• advanced/solo-proof-of-stake-voting.md

• wallets/decrediton/decrediton-setup.md
• wallets/decrediton/using-decrediton.md
• wallets/decrediton/decrediton-troubleshooting.md

• lightning-network/dcrlncli/options-and-commands.md

To get help withdcrdocs please create aGitHub issue or join theDecred community using your preferred chat platform.