MyDocs is a markdown powered knowledgebase.
This is meant to allow for an organized and searchable personal documentation.
@[toc](Table of Contents)
- collapsable sidebar
- create/edit/detele pages from the web interface
- commit changes from the web interface
- search in the provided content
- sidebar with a tree view of the documents
- upload via drag&drop or paste
- auto table of contents
Clone this repo, install the node modules and create the content folder.
git clone https://github.com/ionutvmi/my-docs.git
cd my-docs
npm install
mkdir content
cd content
git init
After that you can add your own md files in the content folder.
In order to view the content from the documentation you need to
place your markdown files (.md) into the /content
folder.
To start the server cd into the root location of this application and
run npm start
.
It is recommended that you keep the /content
folder in a separate git repo thus
taking advantage of the version control for all your content.
The /content folder may contain a subfolder named UPLOADS
which will be ignored
form the indexing in order to allow for static files (images, documents) to be linked
your documentation.
~~Strikethrough~~
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_
# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag
* Item 1
* Item 2
* Item 2a
* Item 2b
1. Item 1
2. Item 2
3. Item 3
* Item 3a
* Item 3b
Links:
[click here](http://example.com)
Images
![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)
Combined
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
As Kanye West said:
> We're living the future so
> the present is our past.
First Header | Second Header
------------- | -------------:
Content Cell | Content Cell
Content Cell | Content Cell
Note: Using :
on the header row you can define the alignement.
I think you should use an
`<addr>` element here instead.
- [x] this is a complete item
- [ ] this is an incomplete item
Three or more...
---
Hyphens
***
Asterisks
___
Underscores
@[toc](Table of Contents)
<span class="label label-default">Default</span>
<span class="label label-primary">Primary</span>
<span class="label label-success">Success</span>
<span class="label label-info">Info</span>
<span class="label label-warning">Warning</span>
<span class="label label-danger">Danger</span>
Default Primary Success Info Warning Danger