{"repo":"decred/dcrdocs","free":true,"listed":false,"github":"https://github.com/decred/dcrdocs","clone":"git clone https://github.com/decred/dcrdocs.git","description":"Documentation for Decred.","language":"Shell","stars":87,"topics":["decred","blockchain","cryptocurrency"],"license":"ISC","category":"blockchain-web3","readme_excerpt":"dcrdocs dcrdocs is source code for the Decred project documentation. dcrdocs is built with MkDocs - a documentation toolkit written in Python. Development Install Python In order to develop on dcrdocs you will need Python installed on your system. Version 3.14 is recommended because this is the version used by the live site, however MkDocs does also support versions 3.8 and later. Python 2 is not supported. You can verify your installation of Python by checking the output from these two commands: Install dependencies To install MkDocs and all of the other Python libraries required by dcrdocs : Getting started 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: If you are using Windows, you may need to inform python to search sys.path for the mkdocs module: Open up 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. Formatting In general, stick to standard Markdown formatting. However, these docs use Material for Mkdocs, so consult their documentation if you need add","default_branch":null,"files":null,"tree":[],"storefront":"/r/decred","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/decred/dcrdocs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}