Spread the knowledge!

JayVii 13bfa6e2a2 Update: Tag6 9 years ago
docs a390134b70 Edit: updated To-Do, fixed formatting 9 years ago
.gitignore f4f5a63cfb NEW: move everything to mkdocs 9 years ago
LICENSE-DOCUMENT eaef87e66e EDIT: Renamed License-Files. 9 years ago
LICENSE-MEDIA 7ddef43092 New: Media License 9 years ago
LICENSE-SOFTWARE eaef87e66e EDIT: Renamed License-Files. 9 years ago
README.md ddbe7649d6 Edit: changed Document-Structure 9 years ago
feed.atom 13bfa6e2a2 Update: Tag6 9 years ago
mkdocs.yml f4f5a63cfb NEW: move everything to mkdocs 9 years ago

README.md

JayVii's Guides

These are the source-documents of JayVii's Docs. There now is a RSS-feed (.atom), which you can use in probably any RSS-reader (tested with newsbeuter):

https://notabug.org/jayvii/Tutorials/raw/master/feed.atom

Documents written in Markdown Site built with MKDocs Site Published with PageKite

You can report issues HERE.

You can contribute by cloning this repository, adding new content and perform a Pull-Request. PLEASE read about the Structure of the Files in this repository, as well as the Document Structure, before contributing. All Documents contributed to this project will be licensed under the FDL. All softwarecode contributed to this project has to be licensed under a FREE SOFTWARE license. All media (including images, sound and video) contributed to this project have to be licensed under the CC BY-SA 4.0.

Not following these guidelines may result in your Pull-Request being rejected.

git clone https://notabug.org/jayvii/Tutorials JayViis_Docs

Structure

File-Structure

./
|-- docs/
|   |
|   |-- $TOPIC-1/
|   |   |
|   |   '-- $SUB-TOPIC-1/
|   |       |
|   |       |-- $CONTENT-1.md
|   |       |
|   |       |-- $CONTENT-1_files/
|   |       |   |
|   |       |   |-- $FILE-1.x
|   |       |   |
|   |       |   '-- $FILE-2.x
|   |       |
|   |       '-- $CONTENT-2.md
|   |
|   |-- $TOPIC-2/
|   |   |
|   |   |-- $SUBTOPIC-1/
|   |   |   |
|   |   |   |-- $CONTENT-1.md
|   |   |   |
|   |   |   '-- $CONTENT-2.md
|   |   |
|   |   |-- $SUB-TOPIC-2/
|   |   |   |
|   |   |   '-- $CONTENT-1.md
|   |   |
|   |   '-- $SUB-TOPIC-3/
|   |       |
|   |       '-- $CONTENT-1.md
|   |
=   =
|   |
|   '-- index.md
|
|-- feed.atom
|
|-- mkdocs.yml
|
|-- README.md
|
|-- LICENSE-DOCUMENT
|
|-- LICENSE-MEDIA
|
|-- LICENSE-SOFTWARE
|
'-- .gitignore

Document-Structure


# Headline of the Article
---

$Optional_Notes

* * *

## Table of Content
1. [Header 1](#header-1)
	* [Sub-Header 1-1](#sub-header-1-1)
	* [Sub-Header 1-2](#sub-header-1-2)
2. [Header 2](#header-2)
3. [Header 3](#header-3)
4. [Sources / Referal Links](#sources-and-referal-links)
5. [About the Author](#about-the-author)

* * *

## Header 1

### Sub-Header 1-1
$CONTENT

### Sub-Header 1-2
$CONTENT

* * *

## Header 2

$CONTENT

* * *

## Header 3

$CONTENT

* * *

## Sources and Referal Links
* [Source 1](https://URL-TO-SOURCE/)
* [Source 2](http://URL-TO-SOURCE/THIS-FILE.html)

* * *

## About the Author
* **Author:** [$USERNAME](https://notabug.org/$USERNAME)
* **Website:** [My Site](https://my-super-amazing-domain.com)
* **Contact:** [Mail](mailto:example@my-super-mailprovider.com), [Twitter](https://twitter.com/$TWITTER-NAME)
* **Misc:** $BRIEF-NOTES

Example: ./docs/integrity/validation/md5/