NishkarshRaj / Markdown-for-Documentation

Licence: MIT License

Markdown is a HTML compatible language used for Documentation.

Projects that are alternatives of or similar to Markdown-for-Documentation

📝 [ M ] arkdown + E [ ditor ] = Mditor

Stars: ✭ 523 (+3635.71%)

Mutual labels: markdown-editor, markdown-parser, markdown-to-html, md

Markdown parser, done right. Commonmark support, extensions, syntax plugins, high speed - all in one. Gulp and metalsmith plugins available. Used by Facebook, Docusaurus and many others! Use https://github.com/breakdance/breakdance for HTML-to-markdown conversion. Use https://github.com/jonschlinkert/markdown-toc to generate a table of contents.

Stars: ✭ 5,252 (+37414.29%)

Mutual labels: markdown-parser, md, markdown-it

markdown articles tool

Parse markdown article, download images and replace images URL's with local paths

Stars: ✭ 37 (+164.29%)

Mutual labels: markdown-parser, markdown-to-html, md

Markvis

make visualization in markdown. 📊📈

Stars: ✭ 1,509 (+10678.57%)

Mutual labels: markdown-editor, markdown-to-html, markdown-it

Markitdown

📱 A React app to preview and edit Markdown✍. You can also export it as HTML.

Stars: ✭ 26 (+85.71%)

Mutual labels: markdown-editor, markdown-parser, markdown-to-html

Proton

A stand-alone application to quickly preview and edit Markdown files using Electron.

Stars: ✭ 140 (+900%)

Mutual labels: markdown-editor, markdown-parser

Pervane

Plain text file based note taking and knowledge base building tool, markdown editor, simple browser IDE.

Stars: ✭ 159 (+1035.71%)

Mutual labels: markdown-editor, md

Wireshark Cheatsheet

Wireshark Cheat Sheet

Stars: ✭ 131 (+835.71%)

Mutual labels: gitbook, cheatsheet

CuteMarkEd-NG

Markdown Editor in Qt 5

Stars: ✭ 55 (+292.86%)

Mutual labels: markdown-editor, markdown-to-html

Macdown

Open source Markdown editor for macOS.

Stars: ✭ 8,855 (+63150%)

Mutual labels: markdown-editor, markdown-to-html

Markdown-Crash-Course

Markdown Crash Course. Learn Markdown language on a simple way.

Stars: ✭ 100 (+614.29%)

Mutual labels: markdown-to-html, md

xkeditor

📝 XK-Editor | 一个支持富文本和Markdown的编辑器

Stars: ✭ 58 (+314.29%)

Mutual labels: markdown-editor, markdown-to-html

html2md

helloworld 开发者社区开源的一个轻量级，强大的 html 一键转 md 工具，支持多平台文章一键转换，并保存下载到本地。

Stars: ✭ 332 (+2271.43%)

Mutual labels: markdown-to-html, md

Markdown

📖Clean & Modern MarkDown Generator, 🔌Offline Support and Easy Generation of Markdown ⚡️⚛️ https://github.com/JP1016/Markdown-Electron/releases

Stars: ✭ 170 (+1114.29%)

Mutual labels: markdown-editor, markdown-to-html

Laravel Smartmd

🎯 A simple markdown editor compatible most markdown parse,You can choose any parse methods on server or client,like Mathematical formula、flowchart、upload image...

Stars: ✭ 76 (+442.86%)

Mutual labels: markdown-editor, markdown-parser

notes

Simple text editor for your Markdown and LaTeX notes.

Stars: ✭ 24 (+71.43%)

Mutual labels: markdown-editor, markdown-to-html

checkyoself

Markdown Grammar Checker for blog posts, etc.

Stars: ✭ 38 (+171.43%)

Mutual labels: markdown-editor, markdown-parser

JMarkPad

Minimalistic markdown editor with real-time preview

Stars: ✭ 32 (+128.57%)

Mutual labels: markdown-editor, markdown-to-html

Idea Multimarkdown

Markdown language support for IntelliJ IDEA.

Stars: ✭ 789 (+5535.71%)

Mutual labels: markdown-editor, markdown-to-html

BoostNote.next-local

Boost Note next local spaces is lightspeed workspace for developers

Stars: ✭ 89 (+535.71%)

Mutual labels: markdown-editor, markdown-to-html

View All Similar Projects ➔

Markdown-for-Documentation

GitHub Readme used for documentation also used .md (markdown) files for documentation.
Note, for all webpages containing any number of md files, GitHub only renders the README.md file on current page if present.

Note

Markdown files can include <html> language code as both are compatible.

How to Contribute

Fork the repository to your own GitHub account.
Clone the repository to your local machine

$ git clone "https://www.github.com/{Username}/Markdown-for-Documentation.git"

where username is your GitHub account username.

Create a branch where you can do your local work. Never work on master branch as we do not allow master commits except by admins.

$ git branch {branchname}
$ git checkout branchname

Do your work and stage your changes.

$ git add <filename>

Commit you changes with a commit message containing your name, file(s) worked upon, changes added.

$ git commit -m "Name| files| Changes"

Push changes to your forked repository

$ git push -u origin branchname

Create a pull request to the upstream repository.

Synchronize forked repository with Upstream repository

Create upstream as our repository

$ git remote add upstream "https://www.github.com/NishkarshRaj/Markdown-for-Documentation"

Fetch upstream changes in local machine

$ git fetch upstream

Switch to master branch

$ git checkout master

Merge changes in local machine

$ git merge upstream/master

Push changes to your forked GitHub repository

$ git push -f origin master

References

Markdown Guide

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

NishkarshRaj / Markdown-for-Documentation

Labels

Projects that are alternatives of or similar to Markdown-for-Documentation

Markdown-for-Documentation

Table of Contents:

How to Contribute

Synchronize forked repository with Upstream repository

References