crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
protocol/docs
History
Elena 0000143b4e
Check for broken links in markdown (#621) 
* Add check-md package and command

* Remove broken references to TESTING.md

* Fix broken link in contributing.md

* Fix staking docs headings

* Add checks for broken links to CI
2022-11-20 11:59:21 +02:00
..
_drawio
minor doc improvements (#57)
2020-11-28 11:21:35 -08:00
_static
Updating docs after cyberpants2077 release (#110)
2021-01-08 11:51:43 -08:00
additional
Add v4 NFT Audits (#435)
2022-03-02 10:46:00 -08:00
advanced
Update protocol docs (#421)
2022-02-11 22:53:49 +10:00
architecture
Add Solidity linter (#608)
2022-11-08 16:12:42 +02:00
basics
Update protocol docs (#421)
2022-02-11 22:53:49 +10:00
scripts
Update protocol docs (#421)
2022-02-11 22:53:49 +10:00
tokenomics
Check for broken links in markdown (#621)
2022-11-20 11:59:21 +02:00
.gitignore
V4 Docs. See live on https://0xprotocol.readthedocs.io. (#56)
2020-11-28 00:51:50 -08:00
conf.py
Update protocol docs (#421)
2022-02-11 22:53:49 +10:00
index.rst
Emergency docs (#94)
2020-12-17 10:24:16 -08:00
make.bat
Adds Template for Specs (#12)
2020-10-27 16:31:15 -07:00
Makefile
V4 Docs. See live on https://0xprotocol.readthedocs.io. (#56)
2020-11-28 00:51:50 -08:00
README.md
V4 Docs. See live on https://0xprotocol.readthedocs.io. (#56)
2020-11-28 00:51:50 -08:00
requirements.txt
fix(docs): pin Sphinx version to 3.x to generate CSS
2021-09-15 18:18:44 -07:00

README.md

Dependencies

    pip3 install sphinx recommonmark sphinx-rtd-theme

Syntax

Documentation can be written in Markdown (.md) or Restructured Text (.rst).

Build and Test

cd docs
make html
open _build/html/index.html

Tips

  • Generate RST tables here.
  • Set your editor's wordwrap to 98 characters.