https://github.com/luctst/just-docs

Writing docs should be simple 📖📖
https://github.com/luctst/just-docs

cli docs documentation documentation-tool es6 nodejs reactjs

Last synced: 2 months ago
JSON representation

Writing docs should be simple 📖📖

• Host: GitHub
• URL: https://github.com/luctst/just-docs
• Owner: luctst
• Created: 2019-09-07T22:00:16.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-31T12:01:44.000Z (over 6 years ago)
• Last Synced: 2025-07-25T09:46:32.718Z (11 months ago)
• Topics: cli, docs, documentation, documentation-tool, es6, nodejs, reactjs
• Language: JavaScript
• Homepage:
• Size: 24.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


	



# Just-Docs

[![Build Status](https://travis-ci.com/luctst/Just-Docs.svg?branch=master)](https://travis-ci.com/luctst/Just-Docs)

[![NPM version](https://img.shields.io/npm/v/Just-Docs?style=flat-square)](https://img.shields.io/npm/v/Just-Docs?style=flat-square)

[![Package size](https://img.shields.io/bundlephobia/min/Just-Docs)](https://img.shields.io/bundlephobia/min/Just-Docs)

[![Dependencies](https://img.shields.io/david/luctst/Just-Docs.svg?style=popout-square)](https://david-dm.org/luctst/Just-Docs)

[![devDependencies Status](https://david-dm.org/luctst/Just-Docs/dev-status.svg?style=flat-square)](https://david-dm.org/luctst/Just-Docs?type=dev)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![Twitter](https://img.shields.io/twitter/follow/luctstt.svg?label=Follow&style=social)](https://twitter.com/luctstt)

*Writing docs should be simple 📖 📖*

## Motivation

Today developers either front or back or even full-stack are overwhelmed, every day there are more and more packages, lib, frameworks etc... It's sometimes complicated to be up to date and a good documentation play a major role in the acquisition of a project.

This is why i decided to create this project, outhere there are some projects like Docusaurus, VuePress, GitBook.. They all do the job very well but i think the basic idea of ​​creating the documentation has been lost from sight for the benefit of:

* Not SEO-friendly.

* Focused on a commercial product.

* Too many features.

* Configuration is not easy.

* ...

Just-docs tends to solve all the problems mentioned above, the main goal is to stay focused on writing documentation for your product and your users. By giving a simple API to use and just what you need to customize your documentation you can stay focus on writing.

The themes of the generated sites were thought by designers so that the reading is more pleasant.

> **Note** - The project is actually in development we're working hard to release it quickly.

## Features

* Simple API to use.

* SSR with React.

* A simple config file no more big config file.

* Beautiful theme, specially build for reading.

## License

MIT

File generated with get-good-readme module.