Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/citrusui/me
The open source code that powers citrusui.me.
https://github.com/citrusui/me
blog firebase jekyll poole scss website
Last synced: about 1 month ago
JSON representation
The open source code that powers citrusui.me.
- Host: GitHub
- URL: https://github.com/citrusui/me
- Owner: citrusui
- License: mit
- Created: 2016-10-25T01:15:19.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-05T23:16:52.000Z (about 6 years ago)
- Last Synced: 2024-10-06T17:18:37.312Z (about 1 month ago)
- Topics: blog, firebase, jekyll, poole, scss, website
- Language: HTML
- Homepage: https://citrusui.me
- Size: 381 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [citrusui.me](https://citrusui.me)
Hello! Welcome to my open source website, powered by [Jekyll](https://jekyllrb.com) and my [custom fork of Poole.](https://github.com/citrusui/poole)
Interested in how development works? Details can be found below.
## Scripts
These scripts are used to publish the site and will automatically run after every commit to Netlify.
`npm run clean`: Removes the `_site` folder.
`npm run dev`: Runs Jekyll using the `development` environment and watches for changes.
`npm run firebase`: Deploys to [Firebase](https://firebase.google.com) static hosting.
`npm run jekyll`: Builds the current site into `_site` using Jekyll.
`npm run lint`: Lints all Sass files in `_sass/` according to rules in `.sass-lint.yml`.
`npm run min`: Minifies HTML output using [html-minifier.](https://www.npmjs.com/package/html-minifier)
`npm run prod`: Runs a Jekyll build using the `production` environment.
`npm run publish`: Removes the previously built site, lints Sass files, builds a `production` site, minifies HTML output, and deploys to Firebase.
## Process
The [`master`](https://github.com/citrusui/me/tree/master) branch contains the newest changes and should not be considered stable. After each commit, various tests are run. If a commit passes all of its tests, it is then built and automatically published to [dev.citrusui.me](https://dev.citrusui.me) via [Netlify.](https://www.netlify.com)
When the changes in [`master`](https://github.com/citrusui/me/tree/master) are deemed stable, the `version` key in [package.json](https://github.com/citrusui/me/blob/master/package.json) is incremented and published as a Git release tag. These changes are then published to [npm](https://www.npmjs.com/package/citrusui.me) and [Firebase Hosting.](https://firebase.google.com/docs/hosting/)
# Terms
Code licensed under [MIT.](LICENSE.md) Blog posts (anything in [`blog/_posts`](https://github.com/citrusui/me/tree/master/blog/_posts)) licensed [CC-BY-NC-SA 4.0.](blog/LICENSE.md)