Nurturing Pluto's Martians

    idoc
    TypeScript icon, indicating that this package has built-in type declarations

    1.21.14 • Public • Published

    idoc

    NPM version CI Dependents Repo npm Downloads npm Downloads npm Downloads

    Generate static pages from all Markdown in a folder.

      ,,        ,,
      db      `7MM
                MM
    `7MM   ,M""bMM  ,pW"Wq.   ,p6"bo
      MM ,AP    MM 6W'   `Wb 6M'  OO
      MM 8MI    MM 8M     M8 8M
      MM `Mb    MM YA.   ,A9 YM.    ,
    .JMML.`Wbmd"MML.`Ybmd9'   YMbmd'

    Quick Start

    Create a idoc site using the beautiful defalut theme.

    $ npx idoc init myapp

    Or

    $ sudo npm i idoc -g
    $ idoc init myapp

    Running the idoc init myapp generator from the command line will create a directory structure with the following elements:

    ├── docs
    │   ├── README.md
    │   └── about.md
    ├── package.json
    └── idoc.yml

    Command Help

    Usage: idoc [init|new][options] [--help|h] [--version|v]
    
    Options:
    
      -v, --version, Show version number
      -h, --help, Displays help information.
      -f, --force, Force file regeneration.
      -d, --dir <dir-path>, Markdown file directory. defalut(docs)
      -o, --output <dir-path>, Output directory. defalut(dist)
      -w, --watch, Watch and compile Markdown files.
      -t, --theme, Customize theme settings. defalut(defalut)
      -m, --minify, minify HTML
    
    Example:
    
      npm idoc init <folder>
      npm idoc new introduce/README.md
      npm idoc new introduce/README.md "Hello World" -f
      npm idoc --theme="defalut"
      npm idoc --dir="docs"
      npm idoc --output="dist"
      npm idoc --watch --output="www"

    Compiled with idoc

    Repo Starred Last Commit Website
    Awesome Mac Github Stars GitHub last commit Preview Website
    MySQL Tutorial Github Stars GitHub last commit Preview Website
    Docker Tutorial Github Stars GitHub last commit Preview Website
    Nginx Tutorial Github Stars GitHub last commit Preview Website
    Vim Web Github Stars GitHub last commit Preview Website
    Git Tips Github Stars GitHub last commit Preview Website
    Awesome UIKit Github Stars GitHub last commit Preview Website
    Shell Tutorial Github Stars GitHub last commit Preview Website
    SwiftUI Example Github Stars GitHub last commit Preview Website
    Swift Tutorial Github Stars GitHub last commit Preview Website
    Handbook Github Stars GitHub last commit Preview Website
    GitHub Actions Github Stars GitHub last commit Preview Website
    HTML Tutorial Github Stars GitHub last commit Preview Website
    C Tutorial Github Stars GitHub last commit Preview Website
    React Native Github Stars GitHub last commit Preview Website

    Contributors

    As always, thanks to our amazing contributors!

    Made with action-contributors.

    License

    Licensed under the MIT License.

    Install

    npm i idoc

    DownloadsWeekly Downloads

    132

    Version

    1.21.14

    License

    MIT

    Unpacked Size

    201 kB

    Total Files

    89

    Last publish

    Collaborators

    • wcjiang