Wondering what’s next for npm?Check out our public roadmap! Β»

    faxx

    0.6.1Β β€’Β PublicΒ β€’Β Published

    Faxx

    It's fun keeping docs and the code to which it refers together, but docs need to get out and about to be useful! Faxx teleports docs from a GitHub repository to wherever you heart desires.

    Development

    Faxx is compiled with Babel, src => dist.

    • $ npm run build

    Will watch and rebuild by default.

    Usage

    Install it everywhere

    • $ npm i -g faxx

    Make faxx part of your build process.

    • $ npm i --save-dev faxx

    Teleportation

    • $ faxx -r manifold/torus -o app/docs

    Keep an eye on a local docs directory

    • $ faxx -l ../manifold/torus -o app.docs

    See --help for additional options.

    Import indexed documentation

    Once the documentation is where you needed it, just import it.

    import docs from './docs '
    

    This assumes you're using babel-raw in tandem with some sort of md => ? transpiler.

    Structure

    β”œβ”€β”€ src
    β”‚   β”œβ”€β”€ catalog.js          # Index documentation
    β”‚   β”œβ”€β”€ download.js         # Download tars from GitHub
    β”‚   β”œβ”€β”€ github.js           # Fetch GitHub releases
    β”‚   β”œβ”€β”€ index.js            # Glue everything together
    β”‚   β”œβ”€β”€ local.js            # Local watch and build
    β”‚   β”œβ”€β”€ options.js          # Options
    β”‚   β”œβ”€β”€ output.js           # Output to fs
    β”‚   └── spinners.js         # Spinners (even sometimes work)
    β”œβ”€β”€ dist                    # Compiled files
    β”œβ”€β”€ docs
    └── bin
    

    Roadmap

    • Much needed refactor
    • Better (any) error messages
    • Serve fetched documentation
    • Examples, and better documentation

    License

    AGPL-3.0β€”see the tl;dr.

    Keywords

    none

    Install

    npm i faxx

    DownloadsWeekly Downloads

    1

    Version

    0.6.1

    License

    AGPL-3.0

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar