pantazos/codepedia

Codepedia is collection of information for all things code

Codepedia 📕

Documentation and glossary for popular programming languages.
Built by the community. Maintained by Codecademy.

Welcome to the Codepedia codebase. We are so excited to have you. With your help, we can build out Codepedia’s content to better serve our learners.

If you're interested in contributing, check out our Contribution Guide.

Running locally

1. Run yarn install-all to download all of the app's dependencies
2. Run yarn start in the root folder
3. Navigate to localhost:5050 to see the local version of Codepedia

If you're running locally and make changes to any file in a _meta folder, you will need to re-run the map generator (yarn build:map) in order to see those changes. There is no live-update version of this script (but you are welcome to create one!)

Adding a new concept

1. In the root folder, run yarn new-entry
2. Follow the prompts to create a new entry for a particular concept / language
3. Open up the Markdown ([concept].md) file that the tool generates for you and edit the file. Follow this standard and use one of these two templates:
   • Encloypedia Entry template
   • Glossary Entry template
4. You should be able to see your new entry in the local version of Codepedia (you may need a refresh)
5. When ready to commit your changes, make sure to include the [concept].md, _meta/[concept].json, and map.json files that were changed