https://github.com/oskarrough/codesandnotes

All articles and the website for Codes & Notes
https://github.com/oskarrough/codesandnotes

hugo learning website

Last synced: 2 months ago
JSON representation

All articles and the website for Codes & Notes

• Host: GitHub
• URL: https://github.com/oskarrough/codesandnotes
• Owner: oskarrough
• License: mit
• Created: 2013-07-02T19:52:53.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2022-07-02T10:11:05.000Z (over 2 years ago)
• Last Synced: 2024-04-13T21:56:35.958Z (9 months ago)
• Topics: hugo, learning, website
• Language: SCSS
• Homepage: https://www.codesandnotes.com
• Size: 53.7 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
> Author's update from summer 2022: most of these articles were written some seven years ago. The web has changed a lot since then. Enjoy!

# Codes & Notes

This is the repository of the book on web development I’m writing. It contains my drafts as well as finished articles, design ideas, personal notes.

☞ Please read the [Introduction to Codes & Notes](https://www.codesandnotes.com/preface/introduction/)

## Development setup

Having used Jekyll, Wordpress, Middleman, my own Gulp generator I've finally settled on [Hugo](http://gohugo.io/) + Gulp to build the book. It's a static site generator written in Go. Super fast (really) and very flexible.

All articles are in the `content` folder. They are written in Markdown format with YAML front-matter. Templates, styles and scripts are in the `app` folder.

### Installing dependencies

You will need Git, Node and Hugo installed on your system. Then go:

1. `git clone [email protected]:oskarrough/codesandnotes.git`

2. `cd codesandnotes`

3. `yarn`

To start a local development server: `yarn start`

### Deployment

To deploy the project, push to the `production` branch. This will trigger Netlify to build and publish to https://www.codesandnotes.com.

## Writing style

Both [Alex](https://github.com/wooorm/alex) and [retext-mapbox-standard](https://github.com/mapbox/retext-mapbox-standard) can be used to check the writing. Take these suggestions with a grain of salt.

`yarn test`