Skip to content
Node.js Blogging Framework
TypeScript JavaScript
Branch: master
Clone or download
Latest commit 318b961 Sep 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode added in all the parsing for the `post` May 1, 2018
bin adding in command line support Sep 6, 2019
blog_example generated summary update Sep 14, 2019
src generated summary update Sep 14, 2019
test generated summary update Sep 14, 2019
.gitignore
.travis.yml Update .travis.yml Aug 31, 2019
LICENSE updating license date Sep 1, 2019
README.md
logo.png updating readme Aug 16, 2019
package.json v0.6.8 Sep 14, 2019
tsconfig.json Update tsconfig.json Sep 6, 2019
yarn.lock adding in summary Sep 7, 2019

README.md

Writr


A Simple to Use Markdown Blog

Build Status GitHub license codecov npm


Getting Started

1. Install Writr

npm install -g writr

2. Setup your directory (look at /blog_example for how to do this)

blog/*.md           //markdown files in the folder root
blog/images         //images for the blog
blog/config.json    //config file 

3. Run Writr on it with defaults. This will output everything to ./blog_output

writr --path ./blog

4. Express Integration

Then in express map your blog_output via static files:

app.use("/blog/*/images", express.static(path.join(__dirname, "blog_output/images")))
app.use("/blog/images", express.static(path.join(__dirname, "blog_output/images")))
app.use("/blog", express.static(path.join(__dirname, "blog_output")))

CLI

  • -h, --help: Output usage information
  • -p, --path: Path of where the blog, config, and template are located
  • -o, --output: Path of where to output the generated blog
  • -r, --render: What do you want rendered such as html or json (example --render html,json)
  • -t, --template: The template you want to use in the /templates directory
  • -c, --config: Configuration file location if different than 'path'

Templates

There are three templates that are part of every instance of Writr:

  • index: This is the main template that lists all of the latest blogs or what you want to add.
  • post: The post itself and usually supporting items around that such as what is next to look at and tags.
  • tags: Showing articles by tag filtering.

Markdown

To learn more about Markdown go here: https://markdownguide.org

You can’t perform that action at this time.