💡 Visit tinkerhub.org/learn/python for the python path.
- Download and install Hugo
- Fork the repository to your profile by clicking here
- Clone the forked repository by running the follwing command:
git clone https://github.com/{Your-github-username-here}/TinkerHub-Learning-Paths.git
- Create a new branch from main by typing the following command:
git checkout -b learning-path-name
- Follow the next steps to create a new learning path or sub path
- Run the following command
hugo new path-name/index.md
You can see that hugo generated a new file named path-name/index.md under the content directory
- Modify the file contents and metadata
- Run
hugo server
to preview your changes on the browser - If you are good with your changes, open a pull request to this repository
Some paths may contain subpaths, you can visit tinkerhub.org/learn/flutter for an example. Follow the steps below to create it.
- Run the command below to create a path
hugo new path-name/_index.md
- Remove the entire contents of the file after the following lines:
---
...metadata
---
- Modify the metadata for your path
- Create subpaths using the following commands
hugo new path-name/subpath1.md
hugo new path-name/subpath2.md
- Modify metadata of path-name/subpath1.md and path-name/subpath2.md and change
sub
key to true - Update the generated files with instructions
- Run
hugo server
to preview your changes on the browser - If you are good with your changes, open a pull request to this repository
Name | Type | Description | Example |
---|---|---|---|
title |
String | Title of the path/subpath | How to learn java |
date |
Date | Date which the path is created | 2021-04-12T13:35:55+05:30 |
type |
Boolean | Set the type of path to language , framework , devops , ai-ml or other |
language |
image |
String | Iimage path, 1024*512px resolution preferred. Images should be uploaded to static/images/path-name | images/java/image.png |
sub |
Boolean | Specifies if a learning path is path or subpath | false |
keywords |
Array | Search terms for the learning path, used by the search bar to do fuzzy search | ["python", "backend"] |
tags |
Array | Used to generate tag pages | ["python", "backend"] |
authors |
Array | github usernames of authors | ["author1", "author2"] |
This project is licensed under MIT License