doclime

1.5.0 • Public • Published

:lemon: Doclime

Make documentation fresh like lime

npm version GitHub version Build Status

Getting started

  1. Copy this index.html to your github-pages folder:
<!-- index.html -->
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>Doclime</title>
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/doclime@latest/dist/doclime.css">
</head>
<body>
 
  <div id="root"></div>
 
  <script src="https://cdn.jsdelivr.net/npm/doclime@latest/dist/doclime.js"></script> 
  <script>
    doclime.init({
      title: 'Doclime',
      nav: {
        'default': [
          {
            title: 'Homepage',
            path: '/',
            src: 'https://raw.githubusercontent.com/clippedjs/doclime/master/README.md'
          },
          {title: 'Getting started', path: '/getting-started/hello-world'}
        ]
      }
    })
  </script> 
</body>
</html>
  1. Done 😏

Credits

Doclime is basically a clipped preset version of it

Readme

Keywords

none

Package Sidebar

Install

npm i doclime

Weekly Downloads

18

Version

1.5.0

License

ISC

Unpacked Size

2.46 MB

Total Files

31

Last publish

Collaborators

  • inizio1