The simplest way to build website for your OSS project.
yarn global add magi # or npm npm i -g magi
# site name > site description ## section title > section description section body content, **looks not bad huh**.
magi in your terminal, open browser and you'll see:
How does it work?
# h1 is used as site name,
blockquote after that will be used as site description, and all other stuffs between
h2 will be put in the banner.
Here's another using developit/unfetch as example:
Add a GitHub corner ribbon
You can use html-matter to set it anywhere in your markdown file, for example, at the top of it:
<!-- @magi github: owner/repo -->
Notice that it should start with
@magi so that we know we need to parse it, the rest part of it is simple front-matter syntax used in Jekyll.
External styles and scripts
script tag with external resource:
<!-- @magi styles: - ./css/custom.css scripts: - ./js/app.js - ./js/post.js -->
# defaults to README.md # run server to preview magi [file] # build html file magi build [file] # defaults to output to index.html # but you can change it magi build [file] --out docs/index.html
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D