JSPM

docsify

1.1.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 56694
  • Score
    100M100P100Q139969F
  • License MIT

A magical documentation generator.

Package Exports

  • docsify

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docsify) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

docsify

Build Status npm

🃏 A magical documentation site generator.

Features

  • Easy and lightweight
  • Custom themes
  • No build

Quick start

Create a 404.html and README.md into /docs.

404.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body></body>
<script src="//unpkg.com/docsify"></script>
</html>

Or Create a index.html and using hash router.

index.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body></body>
<script src="//unpkg.com/docsify" data-router></script>
</html>

Showcase

These open-source projects are using docsify to generate their sites. Pull requests welcome : )

  • docsify - A magical documentation site generator.
  • Snipaste - A new way to boost your productivity.

How to contribute

  • Fork it!
  • Run npm i && npm run dev
  • open localhost:3000

License

MIT

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!

Beerpay Beerpay