Zettlr github how to#

MkDocs is a comprehensive library that allows for easy building of whole documentations. To locally test how your changes work out, you'll need to install MkDocs. gitignore file will not commit this directory. You can create a resources directory on the root level to store additional files that you may need, as the. The rest of the files are independent and unique for each language. Inside these, you will find one assets-folder, which contains a symbolic link to the top-level assets's app.css-file. Inside the docs-subdirectory, you'll find all languages inside ISO-coded directories.

Zettlr github how to#

If you have an idea on how to structure the documentation, please start a thread in the discussions tab of the main repository or join the discord server. New pages in our documentation will require some structural adjustments, which you need to discuss beforehand. Commit them and then open a Pull Request.Īs soon as we run a new build, your changes will automatically be included and are available at.Modify the Markdown source files, and other files as necessary.Then, simply modify the page contents and create a pull request.įor advanced editing, here's the list of steps for contributing to the documentation: Therefore, to contribute you only need to know a little bit of Markdown! Simply browse the documentation, and click the 'Edit on GitHub' button on the page you want to edit. The whole documentation is written in Markdown. It is hosted publicly on GitHub to give you the chance to easily submit modifications and help the Zettlr documentation stay comprehensive even for new users who need a hand in getting to grips with Zettlr.Ĭontributions from the Community are encouraged! If you spot typos, wrong or outdated information, or have other good input to improve the documentation, we appreciate all your ideas. This repository holds the official documentation for the Zettlr markdown app.