API Generator RUBY

This app generates a markdown to generate a slate automated documentation

pre-require

have paw installed in your computer

PAW

have node.js have nexe yarn global add nexe

steps

the structure of your paw document should have at the beginning a introduction end-point that is the first page in slate

then for every resource generate a group with respective end-points it should look something like This

introduction . ├── introduction (doesn't make any call just get the description) ├── Users_app | ├── GET users | └── POST user . . .

1. get the extension and save it in your extension directory
2. exporte ⌘shiftE
3. save it at root of your documentation project
4. copy the file setup.sh (is in extension folder)
5. run ./setup.sh
6. cd into slate
7. run bundle exec middleman server

note

• I have a hook that doesn't allow you to push changes until you update your CHANGELOS.md
• You can change the shell file inside the make-setup with the command nexe index.js -n setup.sh