- Choose a unique ID for your new tip:
- There shouldn't already be a file in
src/tips/enwith the name<the-new-id>.md - Make the ID human-readable, so it's easy to know what the tip is about without opening the md file
- Use only lowercase characters and replace spaces with
- - Since the ID is used for the name of the file, it's important that once it's chosen, it doesn't change. Otherwise we might lose commit history on tips and we use it to attribute authorship on tops pages.
- There shouldn't already be a file in
- Create the md file:
- Create a new file:
src/tips/en/<the-new-id>.md - Add a front matter to the file with the following information:
title: A title for the tiptags: A list of categories and browsers that correspond to this tip- Reuse existing categories (found in other tips, like
css,console, etc.) - At the end of the list, insert the browsers that this tip works on, by adding a tag that starts with
browser:followed by eitheredge,firefoxorchrome
- Reuse existing categories (found in other tips, like
- Add the content of the tip in the file, as markdown. Don't use headings, but feel free to format your content with italic, bold, bullet points, line breaks, etc.
- Try to add an image as this helps user a lot. Please include only 1 image if possible, and please add alt text.
- Place the image in
src/assets/imgand give it the same name as the tip md file:<the-new-id>.png
- Place the image in
- Create a new file:
- Build the site locally to test that things work fine
- Open a pull request to get your new tip reviewed and checked-in
TODO
First make sure you have cloned the repo locally, then open a command line at the root of the repo.
npm initto get all of the dependencies installednpx @11ty/eleventy --serveto launch the build and start a local server- Then open a browser and navigate to localhost:8080
The page should auto-reload as you make changes to source code.