Added initial skeleton of documentation.
Signed-off-by: Tony Tkáčik <tonydamage@gmail.com>
This commit is contained in:
parent
c5f24c3ca1
commit
6704dc25fe
8 changed files with 248 additions and 1 deletions
24
README.md
24
README.md
|
|
@ -1,3 +1,25 @@
|
|||
# learn
|
||||
|
||||
Documentation, Tutorials & Findings regarding 3D printing, DIY production
|
||||
Documentation, Tutorials & Findings regarding 3D printing, DIY production
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Project uses [mkdocs] and [mkdocs-material] to render and serve documentation.
|
||||
|
||||
### Project layout
|
||||
|
||||
mkdocs.yml # The configuration file for [mkdocs].
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
|
||||
### Commands
|
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project.
|
||||
* `mkdocs serve` - Start the live-reloading docs server.
|
||||
* `mkdocs build` - Build the documentation site.
|
||||
* `mkdocs help` - Print this help message.
|
||||
|
||||
[mkdocs]:http://mkdocs.org
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue