computer-scienceangular-roadmapbackend-roadmapblockchain-roadmapdba-roadmapdeveloper-roadmapdevops-roadmapfrontend-roadmapgo-roadmaphactoberfestjava-roadmapjavascript-roadmapnodejs-roadmappython-roadmapqa-roadmapreact-roadmaproadmapstudy-planvue-roadmapweb3-roadmap
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kamran Ahmed
5ef4b698cb
|
2 years ago | |
---|---|---|
.. | ||
build.sh | 2 years ago | |
content-skeleton.ts | 2 years ago | |
pr-review.sh | 2 years ago | |
readme.md | 3 years ago | |
roadmaps-meta.js | 3 years ago | |
sitemap.js | 2 years ago | |
squash-merge.sh | 2 years ago |
readme.md
Scripts
Here is the list of scripts available:
Sitemap
Generates the sitemap with all the pages and guides
npm run meta:sitemap
Roadmaps Meta
Generates the content/roadmaps.json
file by combining the content/raodmaps/**/meta.json
content in each roadmap
npm run meta:roadmaps
Content Skeleton
This command is used to create the content folders and files for the interactivity of the roadmap. You can use the below command to generate the roadmap skeletons inside a roadmap directory:
npm run roadmap-content [frontend|backend|devops|...]
For the content skeleton to be generated, we should have proper grouping, and the group names in the project files. You can follow the steps listed below in order to add the meta information to the roadmap.
- Remove all the groups from the roadmaps through the project editor. Select all and press cmd+shift+g
- Identify the boxes that should be clickable and group them together cmd+shift+g
- Assign the name to the groups.
- Group names have the format of
[sort]-[slug]
e.g.100-internet
. Each group name should start with a number starting from100
which helps with sorting of the directories and the files. Groups at the same level have the sequential sorting information. - Each groups children have a separate group and have the name similar to
[sort]-[parent-slug]:[child-slug]
wheresort
refers to the sorting of thechild-slug
and not the parent. Alsoparent-slug
does not need to have the sorting information as a part of slug e.g. if parent was100-internet
the children would be100-internet:how-does-the-internet-work
,101-internet:what-is-http
,102-internet:browsers
.
- Group names have the format of