S
S
Sergey Melodin2018-09-21 10:09:30
Documentation
Sergey Melodin, 2018-09-21 10:09:30

What are the tools for markdown?

There is a task of compiling project documentation in Markdown. The first obvious problems:
1. Automate the insertion of content, buttons "to the top" at the end of pages;
2. Automated navigation*;
3. Support for some features, such as mermaid ;
4. Tables, images, etc...
* Automated navigation means that the files in the directory are arranged alphabetically, but the reading order, of course, is different. So I'd like to add a bottom navigation with a "next" and "back" button. Automation is needed for those cases when the structure of directories and files or their names have changed.
I work in PhpStorm, it makes life a little easier on its own, but this is not enough.
If I understand correctlyLaTeX Editor or maybe Storm's Markdown Navigator Plugin .
Question:
Did I choose the right tools and can you add/suggest something else?

Answer the question

In order to leave comments, you need to log in

4 answer(s)
S
Sergey Melodin, 2018-09-25
@melodyn

Now I know for sure that the Markdown Navigator plugin is able to generate a table of contents automatically, works with Mermaid and generally has a lot of goodies, so I left it as the main tool.
With auto-navigation, I decided to stumble on my own or score on it, depending on how it goes.

E
Edward Tibet, 2018-10-13
@eduardtibet

If Markdown is for you, take a look at the Foliant project: https://github.com/foliant-docs/foliant

A
Aleksandr, 2018-09-21
@alexgearbox

A wiki with markdown support.

R
Ranwise, 2018-09-22
@Ranwise

there are systems for docks, for example mkdocs, look for analogues, theoretically some kind of static site generator may suit you, make your own template

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question