0.6.1 • Published 6 years ago
faxx v0.6.1
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
0.6.1
6 years ago
0.6.0
7 years ago
0.5.2
7 years ago
0.5.1
7 years ago
0.5.0
7 years ago
0.4.0
7 years ago
0.3.0
7 years ago
0.2.6
7 years ago
0.2.5
7 years ago
0.2.4
7 years ago
0.2.3
7 years ago
0.2.2
7 years ago
0.2.1
7 years ago
0.2.0
8 years ago
0.1.7
8 years ago
0.1.6
8 years ago
0.1.5
8 years ago
0.1.4
8 years ago
0.1.3
8 years ago
0.1.2
8 years ago
0.1.1
8 years ago
0.1.0
8 years ago