Skip to content

Commit

Permalink
Badge
Browse files Browse the repository at this point in the history
  • Loading branch information
bcomnes committed Nov 13, 2023
1 parent 86c5ec3 commit f946d89
Show file tree
Hide file tree
Showing 3 changed files with 693 additions and 589 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# top-bun
[![npm version](https://img.shields.io/npm/v/top-bun.svg)](https://npmjs.org/package/top-bun)
[![Actions Status](https://github.com/bcomnes/top-bun/workflows/tests/badge.svg)](https://github.com/bcomnes/top-bun/actions)
[![Coverage Status](https://coveralls.io/repos/github/bcomnes/top-bun/badge.svg?branch=master)](https://coveralls.io/github/bcomnes/top-bun?branch=master)
[![Types in JS](https://img.shields.io/badge/types_in_js-yes-brightgreen)](https://github.com/voxpelli/types-in-js)
Expand Down Expand Up @@ -67,9 +68,10 @@ src % tree
β”‚ β”œβ”€β”€ blog.layout.client.js # layouts can also define a layout client.
β”‚ β”œβ”€β”€ article.layout.js # layouts can extend other layouts, since they are just functions.
β”‚ └── root.layout.js # the defult layout is called root.
β”œβ”€β”€ global.client.js # you can define a global js client that loads on every page.
β”œβ”€β”€ global.css # you can define a global css file that loads on every page.
β”œβ”€β”€ global.vars.js # site wide variables get defined in global.vars.js.
β”œβ”€β”€ globals # global assets can live anywhere. Here they are in a folder called globals.
β”‚ β”œβ”€β”€ global.client.js # you can define a global js client that loads on every page.
β”‚ β”œβ”€β”€ global.css # you can define a global css file that loads on every page.
β”‚ └── global.vars.js # site wide variables get defined in global.vars.js.
β”œβ”€β”€ README.md # This is just a top level page built from a README.md file.
β”œβ”€β”€ client.js # the top level page can define a page scoped js client.
β”œβ”€β”€ style.js # the top level page can define a page scoped Css style.
Expand Down Expand Up @@ -584,9 +586,15 @@ Some noteable features are included below, see the [roadmap](https://github.com/

`top-bun` used to be called `siteup` which is sort of like "markup", which is related to "markdown", which inspired the project [`sitedown`](https://ghub.io/sitedown) to which `top-bun` is a spiritual offshot of. Put a folder of web documents in your `top-bun` oven, and bake a website.

## Links

- [CHANGELOG](CHANGELOG.md)
- [CONTRIBUTING](CONTRIBUTING.md)
- [Dependencies](dependencygraph.svg)

## License

MIT
[MIT](LICENSE)

[uhtml]: https://github.com/WebReflection/uhtml
[hb]: https://handlebarsjs.com
Expand Down

0 comments on commit f946d89

Please sign in to comment.