Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upUnify docs with webtorrent-www #507
Comments
This comment has been minimized.
This comment has been minimized.
|
There's no way to embed external .md in markdown (in GitHub. What we can do is load the README.md, remove the non-api parts and present it in the website. |
This comment has been minimized.
This comment has been minimized.
|
What might be possible is the opposite: include webtorrent README.md (or a API.md subset extracted from it) into the jade file, since it's possible to include markdown in jade http://jade-lang.com/reference/includes/ edit: I guess including the whole README.md might be ok |
This comment has been minimized.
This comment has been minimized.
|
I'm working on fixing this right now. |
This comment has been minimized.
This comment has been minimized.
|
This is done! Docs now live in |
This comment has been minimized.
This comment has been minimized.
|
This thread has been automatically locked because it has not had recent activity. To discuss futher, please open a new issue. |
The WebTorrent API docs live in two places right now:
README.mdin this reposerver/views/docs.jadeinwebtorrent-wwwLet's unify these so we don't need to keep them manually in sync.
Also, move examples from
examples/to the website.