tylensthilaire / portfolio

Source code for tylensthilaire.com, portfolio of Tylen St Hilaire. The site and content are maintained in the open as a collaborative exercise.

Tylen St Hilaire's Portfolio
_{Source code for tylensthilaire.com}

This is the source code for tylensthilaire.com, a collection of creative output from Tylen St Hilaire. The site and content are created and maintained in public, as an exercise in practice and collaboration.

Contributing

This website is continually evolving. Suggestions, improvements and bugs are welcomed via issues or by a pull request from your fork.

Design and content

The easiest way to contribute to the design or content is by raising an issue and describing the suggested change. For more substantial changes a pull request is recommended. If you don't use GitHub, you can download the repo edit the .sketch or .md files, and attach them (zipped) to an issue.

Code

All but the most negligible code contributions should come in the form of a pull request. To run the site locally, clone the repo, install the npm dependencies and run the serve command. Once cloned, the repository should be self documenting – if not, raise an issue for help.

Quickstart steps

1. Clone this Repository

git clone https://github.com/tylensthilaire/portfolio.git my-fork

2. Navigate to the directory

cd my-fork

3. Install dependencies

npm install

4. Run Locally

npx eleventy --serve

Conventions

Semantic versioning is used to track version numbers following the SemVer standard.

• Version numbers aren't too important for the repo as a whole, but are important for content.
• Each content file has an individual version number, separate from the repository as a whole.
• Content changes do not update the repo version number.
• The repo version number is stored in the package.json,
• Version numbers for content are stored in the yaml frontmatter of each markdown file.

Commit messages should follow the Conventional Commits standard.

• This makes the project history easy to understand and helps track changes for semantic versioning.

Self documenting code, in the form of comments, ensures the repo is easy for people to pick up and run with.

• Comment everything. E v e r y t h i n g.
• Designers should be able to read the code, because at least one will need to read the code.

Semantic line breaks keeps content version-control friendly. For more information see Semantic Line Breaks.

• Following the letter of the specification is not required.
• Following the spirit is.

Project structure

.
├─ _data/metadata.json      // Global data file
├─ _includes
│  ├─ layouts
│  │  ├─ base.njk           // Master template
│  │  ├─ home.njk           // Homepage template
│  │  └─ post.njk           // Post template
│  └─ postslist.njk         // Post lists component
├─ .github/funding.yml
├─ .vscode/settings.json
├─ about                    // Bio page
├─ css                      // Electron JS app folder
├─ feed                     // Feed files
│  └─ ...
├─ img                      // Image files
│  └─ ...
├─ posts
│  └─ ...                   // Posts
├─ .editorconfig
├─ .gitignore
├─ .nvmrc
├─ .travis.yml
├─ archive.njk
├─ index.njk                // Homepage
├─ LICENSE
├─ netlify.toml
├─ package.json
├─ page-list.njk
├─ README.md                // ☛ You are here
├─ sitemap.xml.njk
├─ tags-list.njk
└─ tags.njk

Help

For help, raise an issue and label it question. Alternatively, contact an author directly.

Technologies

This website is created using the following technologies

Authors

@tylensthilaire

You?

Licence

© 2020–present, Tylen St Hilaire
Except where otherwise noted, code is licenced under MIT and content is licenced under CC BY-SA 4.0.