Skip to content

ntillier/EasyDocs

Repository files navigation

EasyDocs

EasyDocs is a lightweight & easy-to-use documentation website generator. Whether you're a developer, a content creator, or a business owner, EasyDocs empowers you to effortlessly craft well-organized and visually appealing documentation using the power of Markdown.

Note

I am redoing EasyDocs from scratch with lots of new features. I have many important tasks to finish, but I hope it will be done in around 3-4 months.

Demo - Website

Install

npm install @nathanti/easydocs --global

Create a project

easydocs init

Develop a project

easydocs dev

Build a project

easydocs build

Roadmap

I plan to add new features gradually.

  • Improve iframes
  • Add icons to links
  • Add the possibility to use base paths
  • Add multilanguage feature
  • Improve the Table of Contents
  • Improve extensibility & customization
  • Improve SEO and accessibility
  • Add search input in the navbar
  • Add markdown functionnalities (tabs, details, custom components)