Welcome to markdown-guide’s documentation! ¶ Markdown is a lightweight markup language, originally created by John Gruber and Aaron Swartz allowing people “to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML). LaTeX math (and even macros) can be used in markdown documents. Several different methods of rendering math in HTML are provided, including MathJax and translation to MathML. LaTeX math is converted (as needed by the output format) to unicode, native Word equation objects, MathML, or roff eqn. MkDocs is a fast, simpleand downright gorgeousstatic site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introduction below, then check the User. The documentation is a collection of books.Each book has a unique title and contains several chapters.Each chapter should be written in a separate markdown file.
Markdown Monster is an easy to use and extensible Markdown Editor for Windows, that provides you with intuitive features to write Markdown content efficiently.
Use the Documentation, Luke
This documentation isn't meant to cover every aspect of the user interface. We think that Markdown Monster is easy to use and works without requiring much hand holding.
Rather these pages highlight some of the not so obvious features of Markdown Monster and provide a reference for configuration and common operations. You probably won't need it, but to get the most out of Markdown Monster's features, it's worthwhile to scan through the common tasks and editor features to see if there features that can make you more productive and that you weren't aware of.
Here are a few things to get you started.
Docs Markdown Extension
Project documentation with Markdown.
MkDocs is a fast, simple and downright gorgeous static sitegenerator that's geared towards building project documentation. Documentationsource files are written in Markdown, and configured with a single YAMLconfiguration file. Start by reading the introduction below, then check the UserGuide for more info.
MkDocs builds completely static HTML sites that you can host on GitHub pages,Amazon S3, or anywhere else you choose.
Great themes available
There's a stack of good looking themes available for MkDocs. Choose betweenthe built in themes: mkdocs and readthedocs, select one of the 3rdparty themes listed on the MkDocs Themes wiki page, or build your own.
Preview your site as you work
The built-in dev-server allows you to preview your documentation as you'rewriting it. It will even auto-reload and refresh your browser whenever you saveyour changes.
Easy to customize
Get your project documentation looking just the way you want it by customizingthe theme and/or installing some plugins.
Install with a Package Manager
If you have and use a package manager (such as apt-get, dnf, homebrew,yum, chocolatey, etc.) to install packages on your system, then you maywant to search for a 'MkDocs' package and, if a recent version is available,install it with your package manager (check your system's documentation fordetails). That's it, you're done! Skip down to Getting Started.
If your package manager does not have a recent 'MkDocs' package, you can stilluse your package manager to install 'Python' and 'pip'. Then you can use pip toinstall MkDocs.
In order to manually install MkDocs you'll need Python installed on yoursystem, as well as the Python package manager, pip. You can check if you havethese already installed from the command line:
MkDocs supports Python versions 3.5, 3.6, 3.7, 3.8, and pypy3.
Install Python by downloading an installer appropriate for your system frompython.org and running it.
If you are installing Python on Windows, be sure to check the box to havePython added to your PATH if the installer offers such an option (it'snormally off by default).
If you're using a recent version of Python, the Python package manager, pip,is most likely installed by default. However, you may need to upgrade pip to thelasted version:
If you need to install pip for the first time, download get-pip.py.Then run the following command to install it:
mkdocs package using pip:
You should now have the
mkdocs command installed on your system. Run
mkdocs--version to check that everything worked okay.
If you would like manpages installed for MkDocs, the click-man tool cangenerate and install them for you. Simply run the following two commands:
See the click-man documentation for an explanation of why manpages arenot automatically generated and installed by pip.
If you are using Windows, some of the above commands may not workout-of-the-box.
A quick solution may be to preface every Python command with
python -mlike this:
For a more permanent solution, you may need to edit your
PATH environmentvariable to include the
Scripts directory of your Python installation.Recent versions of Python include a script to do this for you. Navigate toyour Python installation directory (for example
C:Python38), open the
Scripts folder, and run the
win_add2path.py file by doubleclicking on it. Alternatively, you can download the script and run it(
Getting started is super easy.
Take a moment to review the initial project that has been created for you.
There's a single configuration file named
mkdocs.yml, and a folder named
docs that will contain your documentation source files. Right now the
docsfolder just contains a single documentation page, named
MkDocs comes with a built-in dev-server that lets you preview your documentationas you work on it. Make sure you're in the same directory as the
mkdocs.ymlconfiguration file, and then start the server by running the
http://127.0.0.1:8000/ in your browser, and you'll see the defaulthome page being displayed:
The dev-server also supports auto-reloading, and will rebuild your documentationwhenever anything in the configuration file, documentation directory, or themedirectory changes.
docs/index.md document in your text editor of choice, change theinitial heading to
MkLorum, and save your changes. Your browser willauto-reload and you should see your updated documentation immediately.
Now try editing the configuration file:
mkdocs.yml. Change the
site_name setting to
MkLorum and save the file.
Your browser should immediately reload, and you'll see your new site name takeeffect.
Now add a second page to your documentation:
As our documentation site will include some navigation headers, you may want toedit the configuration file and add some information about the order, title, andnesting of each page in the navigation header by adding a
Save your changes and you'll now see a navigation bar with
Aboutitems on the left as well as
Next items on theright.
Windows rdp protocol. Try the menu items and navigate back and forth between pages. Then click on
Search. A search dialog will appear, allowing you to search for any text onany page. Notice that the search results include every occurrence of the searchterm on the site and links directly to the section of the page in which thesearch term appears. You get all of that with no effort or configuration on yourpart!
Theming our documentation
Now change the configuration file to alter how the documentation is displayed bychanging the theme. Edit the
mkdocs.yml file and add a
Save your changes, and you'll see the ReadTheDocs theme being used.
Changing the Favicon Icon
By default, MkDocs uses the MkDocs favicon icon. To use a different icon, createan
img subdirectory in your
docs_dir and copy your custom
favicon.ico fileto that directory. MkDocs will automatically detect and use that file as yourfavicon icon.
Building the site
That's looking good. You're ready to deploy the first pass of your
MkLorumdocumentation. First build the documentation:
This will create a new directory, named
site. Take a look inside thedirectory:
Notice that your source documentation has been output as two HTML files named
about/index.html. You also have various other media that'sbeen copied into the
site directory as part of the documentation theme. Youeven have a
sitemap.xml file and
If you're using source code control such as
git you probably don't want tocheck your documentation builds into the repository. Add a line containing
site/ to your
If you're using another source code control tool you'll want to check itsdocumentation on how to ignore specific directories.
After some time, files may be removed from the documentation but they will stillreside in the
site directory. To remove those stale files, just run
Other Commands and Options
There are various other commands and options available. For a complete list ofcommands, use the
Markdown Documentation File
To view a list of options available on a given command, use the
--help flagwith that command. For example, to get a list of all options available for the
build command run the following:
The documentation site that you just built only uses static files so you'll beable to host it from pretty much anywhere. GitHub project pages and AmazonS3 may be good hosting options, depending upon your needs. Upload the contentsof the entire
site directory to wherever you're hosting your website from andyou're done. For specific instructions on a number of common hosts, see theDeploying your Docs page.
Markdown Docs Nodejs
To get help with MkDocs, please use the discussion group, GitHub issues orthe MkDocs IRC channel
#mkdocs on freenode.