From 0d4c84610b92f18a9302181ad3be54bf71f15c37 Mon Sep 17 00:00:00 2001 From: Aleksander Cynarski Date: Sun, 17 Sep 2023 10:00:32 +0200 Subject: [PATCH] init docsify --- docs/.nojekyll | 0 docs/LICENSE | 21 ++++++++++++++++ docs/README.md | 31 +++++++++++++++++++++++ docs/_sidebar.md | 2 ++ docs/index.html | 60 +++++++++++++++++++++++++++++++++++++++++++++ docs/second-page.md | 10 ++++++++ 6 files changed, 124 insertions(+) create mode 100644 docs/.nojekyll create mode 100644 docs/LICENSE create mode 100644 docs/README.md create mode 100644 docs/_sidebar.md create mode 100644 docs/index.html create mode 100644 docs/second-page.md diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..bec4d76 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 docsifyjs + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..e6da20d --- /dev/null +++ b/docs/README.md @@ -0,0 +1,31 @@ +# Docsify Template + +> A simple [Docsify](https://github.com/docsifyjs/docsify/) template for creating Markdown-based documentation sites, with no build process required. + +## Site Setup + +### Static Webserver +Upload these template files to any static web server. The file `.nojekyll` is only required if hosting the site on GitHub Pages and otherwise can be removed. + +### GitHub Pages + +#### Hosting Site + +To host this template on GitHub Pages do the following: + +1. Log into GitHub if you have not done so already +2. Tap the **Use this template** button in the upper-right of this GitHub Repository and choose **Create a new repository** +3. Enter a name for your new Repository and then tap the **Create repository** button +4. Once your new Repostitory is created go to **Settings**, then select **Pages** from the left-hand sidebar, and under **Branch** choose **main** and then tap the **Save** button +5. Wait a minute or two and refresh the same **Pages** page - once your site is ready a message will be displayed at the top of the screen along with a site link and a **Visit site** button + +#### Editing Content + +How about editing the content of your new Docsify site on GitHub Pages? View the Markdown page you want to edit (for example, **README.md**) and tap the **Pencil Icon**, then save any changes by tapping the green **Commit changes...** button. In just a few moments the Docsify site will be automatically updated to reflect those changes. + +### Viewing Locally +Run `npx serve .` (Node.js users) or `python -m http.server 8000` (Python users) in the repo folder to serve run locally. + +## Docsify Documentation + +To learn more about using Docsify, visit https://docsify.js.org. \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..c3e0c8e --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,2 @@ +- [Read Me](README) +- [Example Second Page](second-page) \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..67fd5e1 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,60 @@ + + + + + + + + Ledo - documentation + + + + + + + +
+ + + + + + + + + + + + + + diff --git a/docs/second-page.md b/docs/second-page.md new file mode 100644 index 0000000..c4d175c --- /dev/null +++ b/docs/second-page.md @@ -0,0 +1,10 @@ +# Example Second Page + +This is an example second page that will appear in the Docsify Sidebar. + +```mermaid +graph LR + A --- B + B-->C[fa:fa-ban forbidden] + B-->D(fa:fa-spinner); +```