https://github.com/maxpleaner/markdown_directory_browser
Have a web interface to local markdown files
https://github.com/maxpleaner/markdown_directory_browser
Last synced: 5 months ago
JSON representation
Have a web interface to local markdown files
- Host: GitHub
- URL: https://github.com/maxpleaner/markdown_directory_browser
- Owner: MaxPleaner
- Created: 2015-10-15T00:08:35.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-15T00:09:10.000Z (over 10 years ago)
- Last Synced: 2025-03-24T06:33:40.089Z (about 1 year ago)
- Language: HTML
- Size: 109 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### How to use:
1. write `.md` files inside `drafts/` and `published/`. There can be subfolders.
2. Run `ruby build.rb` to compile `published/` into `compiled/`. This converts the `.md` files to `.html`.
3. `cd compiled/ && file-browser` - this runs the [file-browser](https://www.npmjs.com/package/file-browser) node server. To install `file-browser`, first [make sure npm is installed correctly](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md), then run `npm install -g file-browser`.
4. Open `http://localhost:8088` in a browser.