linkorb/blazon

Blazon: Static site generator

Maintainers

Details

github.com/linkorb/blazon

Homepage

Source

Issues

Installs: 28

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 4

Forks: 1

Open Issues: 0

v1.5.0 2016-11-07 12:59 UTC

Requires

Requires (Dev)

MIT 7f3312f6dc7e90d65e86847ac3de3d23436f9800

  • LinkORB Engineering <engineering.woop@linkorb.com>

phplinkorbstatic site generatorblazon

This package is auto-updated.

Last update: 2021-03-01 00:15:16 UTC

README

Features:

  • Generates static HTML files
  • Write pages in Markdown
  • GFM (Github Flavored Markdown)
  • Preview web-server for local editing
  • Twig templates
  • Assets

Usage:

  1. Create a new directory (or repository)
  2. Add a file called blazon.yml
  3. Create a build/ directory in your repository (optionally add this directory to .gitignore)
  4. Initialize the build directory with static assets from /static/assets: 
        blazon init
  5. Start the preview webserver: 
        blazon serve
  6. Open the following URL in your webbrowser: http://127.0.0.1:8080

The preview server re-generates the site on every request.

Once you're happy with your new site, simply upload the static files in the build/ directory to your webserver or github pages.

License

MIT. Please refer to the license file for details.

Brought to you by the LinkORB Engineering team

687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67
Check out our other projects at linkorb.com/engineering.

Btw, we're hiring!