Initial Commit

Zettlr · May 12, 2019 · 815e682 · 815e682
commit 815e682
Show file tree

Hide file tree

Showing 95 changed files with 13,000 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+!.gitignore
+!/docs
+!mkdocs.yml
+!README.md
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,43 @@
+# Zettlr Documentation
+
+This repository holds the official documentation for the Zettlr markdown app. 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.
+
+**Contributions from the Community are encouraged!** If you spot typos, wrong our outdated information, or have other good input to improve the documentation, we appreciate all your ideas.
+
+## How it Works
+
+The whole documentation is written in Markdown. Therefore, to contribute you only need to know a little bit of Markdown, and then you can modify the documentation! Before we get to the details, here's the list of steps for contributing to the documentation:
+
+1. Fork this repository.
+2. Modify the Markdown source files, and other files as necessary.
+3. Commit them and then open a Pull Request **to the develop branch**.
+
+As soon as we run a new build, your changes will automatically be included and are available at https://docs.zettlr.com/.
+
+## New Pages and Changes to the Structure
+
+New pages in our documentation will require some structural adjustments, which you need to discuss beforehand. If you have an idea on how to structure the documentation, please discuss your structure on our forum. If your changes are reasonable, we will see to making the changes as soon as possible so that you can begin your work.
+
+## The Structure
+
+All source files reside in the `docs` directory. The images reside in the `assets` directory within the `docs`-directory. The names of the files should speak for themselves.
+
+You can use the root directory to store additional files that you may need, as there's a `.gitkeep`-file set to only push this `README.md`, the `mkdocs.yml` configuration file, and the `docs`-directory. So any notes or additional scripts can be placed in the root directory.
+
+## Testing and Building
+
+To locally test how your changes work out, you'll need to install MkDocs. MkDocs is a comprehensive library that allows for easy building of whole documentations. Please follow the instructions by the creators of MkDocs on how to set up the software on your computer.
+
+If MkDocs is set up, inside your directory run:
+
+```bash
+$ mkdocs serve
+```
+
+to start up a local development server which will watch the files as you go. To build the page locally, run:
+
+```bash
+$ mkdocs build
+```
+
+Further commands and options are available at their homepage.
diff --git a/build/404.html b/build/404.html
@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <meta name="author" content="Hendrik ERz">
+  <link rel="shortcut icon" href="img/favicon.ico">
+  <title>Zettlr Docs</title>
+  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+  <link rel="stylesheet" href="css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="css/theme_extra.css" type="text/css" />
+  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
+  <link href="assets/app.css" rel="stylesheet">
+
+  <script src="js/jquery-2.1.1.min.js" defer></script>
+  <script src="js/modernizr-2.8.3.min.js" defer></script>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/javascript.min.js"></script>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/css.min.js"></script>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/yaml.min.js"></script>
+  <script>hljs.initHighlightingOnLoad();</script> 
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+      <div class="wy-side-nav-search">
+        <a href="." class="icon icon-home"> Zettlr Docs</a>
+        <div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="/search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
+  </form>
+</div>
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+	<ul class="current">
+
+
+            <li class="toctree-l1">
+
+    <a class="" href=".">Home</a>
+	    </li>
+
+            <li class="toctree-l1">
+
+    <a class="" href="getting-started/">Getting Started</a>
+	    </li>
+
+            <li class="toctree-l1">
+
+    <a class="" href="guides/">Guides</a>
+	    </li>
+
+            <li class="toctree-l1">
+
+    <a class="" href="components/">Components</a>
+	    </li>
+
+            <li class="toctree-l1">
+
+    <a class="" href="get-involved/">Get involved</a>
+	    </li>
+
+            <li class="toctree-l1">
+
+    <a class="" href="faq/">FAQ</a>
+	    </li>
+
+        </ul>
+      </div>
+      &nbsp;
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+        <a href=".">Zettlr Docs</a>
+      </nav>
+
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href=".">Docs</a> &raquo;</li>
+
+
+    <li class="wy-breadcrumbs-aside">
+
+    </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main">
+            <div class="section">
+
+
+  <h1 id="404-page-not-found">404</h1>
+
+  <p><strong>Page not found</strong></p>
+
+
+            </div>
+          </div>
+          <footer>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <!-- Copyright etc -->
+
+  </div>
+
+  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+  <div class="rst-versions" role="note" style="cursor: pointer">
+    <span class="rst-current-version" data-toggle="rst-current-version">
+
+          <a href="https://github.com/Zettlr/zettlr-docs/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
+
+
+
+    </span>
+</div>
+    <script>var base_url = '';</script>
+    <script src="js/theme.js" defer></script>
+      <script src="search/main.js" defer></script>
+
+</body>
+</html>