https://github.com/leon3s/nxtmdoc

Next Markdown Documentation
https://github.com/leon3s/nxtmdoc

documentation generator markdown nextjs

Last synced: about 1 month ago
JSON representation

Next Markdown Documentation

• Host: GitHub
• URL: https://github.com/leon3s/nxtmdoc
• Owner: leon3s
• Created: 2022-07-08T20:55:48.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T05:12:32.000Z (over 1 year ago)
• Last Synced: 2024-05-02T01:43:54.857Z (7 months ago)
• Topics: documentation, generator, markdown, nextjs
• Language: TypeScript
• Homepage: https://docs.next-hat.com
• Size: 1.9 MB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  
Next Markdown Documentation





 Tags

 

 

  documentation, summary

 



## Motivation

Where `docusaurus` is a thing today and mostly used.

I wanted to experience to make my own.

It's follow better markdown compatibility with `Github`.

So documentation can be both readable in `Github` and on the `Website`.

## How to use it ?

```bash

  npm install && npm run dev ./test_doc

```

See the `Dockerfile` for production

You can have an example of configuration on this [repository](https://github.com/nxthat/documentation)

And an example of a deployed version on this url [docs.next-hat.com](https://docs.next-hat.com)