resume-manpage/README.md

41 lines
1008 B
Markdown
Raw Normal View History

2022-05-23 17:05:30 +06:00
# intro
2022-05-24 16:18:30 +06:00
[![status-badge](https://build.bdeshi.space/api/badges/bdeshi/resume-manpage/status.svg)](https://build.bdeshi.space/bdeshi/resume-manpage)
2022-05-23 17:05:30 +06:00
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
2022-11-18 00:20:19 +06:00
# select node version
$ nvm use
2022-05-23 17:05:30 +06:00
# 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
2022-05-24 16:18:30 +06:00
- `include ./somefile` will be relative to current pug file.
2022-05-23 17:05:30 +06:00
`/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