Skip to content

Commit

Permalink
Config and setup (#5)
Browse files Browse the repository at this point in the history
* Personalize config for reusability

* Add setup docs

* Add designed by

* Update config to direct values

This updates the config to be a direct representation of the values used
on the resulting pages, which while more duplicative in the config file
means more direct control over the end result and less string
interpolation within the page generator.

---------

Co-authored-by: Kevin Jiang <kevin51jiang at email.com>
  • Loading branch information
leebyron authored Jan 2, 2024
1 parent 236f8c8 commit a707b08
Show file tree
Hide file tree
Showing 5 changed files with 1,079 additions and 43 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ straightforward. If setting up your own til is interesting enough to you that
you would be willing to help factor out reusable parts, open an issue to
discuss.


## Setup (only works on *nix)

- Install [NodeJS](https://nodejs.org/en/download)
- Install fzf
- Ubuntu: `sudo apt install fzf`
- Modify the [Config File](./config.mjs) with your own info
- In [GitHub pages](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site), set it so you have the settings:
- Source: Deploy from a branch (Classic Pages experience)
- Branch: `gh-pages`, from the folder `/ (root)`


## License

Code found here is licensed under [MIT]. Content under [CC BY 4.0].
Expand Down
16 changes: 16 additions & 0 deletions config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
export default {
canonicalRoot: "https://leebyron.com/til/",
title: "til",
githubRepo: "leebyron/til",
authorName: "Lee Byron",
authorURL: "https://leebyron.com",
pageTitle: `Things I've Learned / Lee Byron`,
ogTitle: `Lee Byron / til`,
ogDescription: `Things I've Learned: brief blurbs on miscellaneous matter.`,
twitterTitle: `Lee Byron / til: brief blurbs on miscellaneous matter.`,
twitterCreator: "@leeb",
googleName: `Things I've Learned`,
feedTitle: `Lee Byron / til`,
feedSubtitle: `Things I've Learned: brief blurbs on miscellaneous matter.`,
gtag: "UA-61714711-1",
}
Loading

0 comments on commit a707b08

Please sign in to comment.