{"id":29560881,"url":"https://github.com/decred/dcrdocs","last_synced_at":"2025-07-18T15:39:16.265Z","repository":{"id":37545852,"uuid":"57048598","full_name":"decred/dcrdocs","owner":"decred","description":"Documentation for Decred.","archived":false,"fork":false,"pushed_at":"2024-06-26T07:24:07.000Z","size":29139,"stargazers_count":81,"open_issues_count":46,"forks_count":129,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-06-26T08:45:42.201Z","etag":null,"topics":["blockchain","cryptocurrency","decred"],"latest_commit_sha":null,"homepage":"https://docs.decred.org","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/decred.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/contributor-compensation.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":"docs/governance/consensus-rule-voting/consensus-vote-archive.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-25T14:30:00.000Z","updated_at":"2024-06-26T07:24:11.000Z","dependencies_parsed_at":"2023-11-07T17:49:43.528Z","dependency_job_id":"3baacc2e-1dfc-4144-a2ef-d8859e5a83db","html_url":"https://github.com/decred/dcrdocs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/decred/dcrdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decred","download_url":"https://codeload.github.com/decred/dcrdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdcrdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265787558,"owners_count":23828456,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","cryptocurrency","decred"],"created_at":"2025-07-18T15:39:15.739Z","updated_at":"2025-07-18T15:39:16.241Z","avatar_url":"https://github.com/decred.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dcrdocs\n\n[![Build Status](https://github.com/decred/dcrdocs/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/dcrdocs/actions)\n[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)\n\n`dcrdocs` is source code for the [Decred project documentation](https://docs.decred.org).\n\n`dcrdocs` is built with [MkDocs](https://www.mkdocs.org/) - a documentation toolkit written in Python.\n\n## Development\n\n#### Install Python\n\nIn order to develop on `dcrdocs` you will need [Python](https://www.python.org/)\ninstalled on your system.\nVersion 3.9 is recommended because this is the version used by the live site,\nhowever MkDocs does also support versions 3.6 and later.\nPython 2 is not supported.\n\nYou can verify your installation of Python by checking the output from these two\ncommands:\n\n```bash\n$ python --version\nPython 3.9.5\n$ pip --version\npip 21.1.2\n```\n\n#### Install dependencies\n\nTo install MkDocs and all of the other Python libraries required by `dcrdocs`:\n\n```bash\n$ pip install mkdocs \u0026\u0026 pip install --user -r requirements.txt\n```\n\n#### Getting started\n\nThis 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:\n\n```bash\n$ mkdocs serve\nINFO     -  Building documentation...\nINFO     -  Cleaning site directory\nINFO     -  Documentation built in 9.09 seconds\nINFO     -  [13:26:55] Serving on http://127.0.0.1:8000/\n```\n\nIf you are using Windows, you may need to inform python to search sys.path for the mkdocs module:\n\n```bash\n$ python -m mkdocs serve\nINFO     -  Building documentation...\nINFO     -  Cleaning site directory\nINFO     -  Documentation built in 9.09 seconds\nINFO     -  [13:26:55] Serving on http://127.0.0.1:8000/\n```\n\nOpen up \u003chttp://127.0.0.1:8000\u003e 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.\n\n#### Formatting\n\nIn general, stick to standard Markdown formatting. However, these docs use [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/reference/), so consult their documentation if you need additional formatting tools.\n\n## Deploying\n\nTo deploy `dcrdocs`, first build the documentation:\n\n```bash\n$ ./bin/build_docs.sh\n```\n\nThis will build the documentation into a new directory named `site`.\n\nThe 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.\n\n#### Docker\n\n`dcrdocs` can also be built and hosted in a [Docker](https://www.docker.com/) container. Build the container using:\n\n```bash\n$ ./bin/build.sh\n```\n\nThe container can then be run with:\n\n```bash\n$ docker run -d --rm -p \u003clocal port\u003e:80 decred/dcrdocs:latest\n```\n\n## Pages to review upon new releases\n\n#### CLI releases\n\n- `advanced/manual-cli-install.md`\n- `wallets/cli/dcrd-and-dcrwallet-cli-arguments.md`\n- `wallets/cli/dcrctl-rpc-commands.md`\n- `wallets/cli/cli-installation.md`\n- `advanced/solo-proof-of-stake-voting.md`\n- `advanced/verifying-binaries.md`\n- `advanced/secure-cold-wallet-setup.md`\n\n#### politeiavoter releases\n\n- `advanced/solo-proof-of-stake-voting.md`\n\n#### Decrediton releases\n\n- `wallets/decrediton/decrediton-setup.md`\n- `wallets/decrediton/using-decrediton.md`\n- `wallets/decrediton/decrediton-troubleshooting.md`\n\n#### dcrlnd release\n\n- `lightning-network/dcrlncli/options-and-commands.md`\n\n## Getting help\n\nTo get help with `dcrdocs` please create a [GitHub issue](https://github.com/decred/dcrdocs/issues) or join the [Decred community](https://decred.org/community/) using your preferred chat platform.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdcrdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecred%2Fdcrdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdcrdocs/lists"}