add content and change project layout

This commit is contained in:
2022-05-23 17:05:30 +06:00
parent 824c7777a9
commit 7b0a2197fc
41 changed files with 747 additions and 9 deletions

37
README.md Normal file
View File

@ -0,0 +1,37 @@
# intro
this is a manpage-like html template, but tbh it's not really a manpage
created with [pug][pug] and [sass][sass], build with [parcel][parcel].
## setup
```bash
# install dependencies
$ yarn install
# build the output
$ yarn build
# build results are here
$ ls dist
```
## contents
`/index.pug`: the starting point of the template.
`/vars.pug`: sample variables. copy it to `/vars.local.pug` and edit it.
`/includes`: template parts are located here.
- `include /somefile` from anywhere will look for `somefile` in project root
- `include somefile` will be relative to current pug file.
`/assets`: css/sass, scripts, images etc are located here.
`/assets/styles/index.sass`: the starting point of the sass template.
---
[pug]: https://pugjs.org
[sass]: https://sass-lang.com
[parcel]: https://parceljs.org