Comments (7)
Maybe something like this?
https://github.com/Kitware/CMake/blob/master/Help/dev/documentation.rst
https://github.com/Kitware/CMake/tree/master/Help
The good thing about RST is that it is used by several serious projects to write documentation. All we really need are things like tables, images, automatic tables of contents, and cross-document links. Any tool that supports RST should be able to deal with them. We don't even need to decide which conversion tool to use right away, it would be possible to try with a couple of them using the same source files.
from gbadoc.
I would be in favour of RST, or any markup language that is reasonably close to plain text. This ensures the source text remains readable no matter how it is viewed, and means people don't need any special tools or significant knowledge to make contributions.
I have no particular preference on the exact tools use, as long as they do not form a barrier for potential contributors.
from gbadoc.
- I second RST and have no issues with Markdown if someone proposes a tool that does everything we need in md
- I think Sphinx is a good place to start, I don't really know any other tools to go from RST -> HTML so I'm definitely open to suggestions
from gbadoc.
https://github.com/rust-lang/mdBook makes quite good HTML output from MarkDown.
from gbadoc.
https://www.mkdocs.org is another possibility for MD -> HTML, with client-based search and easy template creation.
from gbadoc.
I'd go for markdown. We can always switch to RST later (pandoc
)
from gbadoc.
Markdown is good for me too!
from gbadoc.
Related Issues (10)
- RFC: Scope of the document HOT 8
- RFC: License HOT 7
- RFC: Document Baseline HOT 7
- github repo settings HOT 5
- RFC: Naming Conventions HOT 13
- RFC: RFCs and the contribution process HOT 2
- PDF export
- favicon HOT 1
- Audio docs
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from gbadoc.