2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# How to work on the docs theme
 
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								>  [!NOTE] A quick reminder that you do not need to setup anything for working on the content for the documentation site.
 
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								> 
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								>  To work on the contributing guidelines, you can edit or add files in the `docs` directory [available here](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/docs). When your changes are merged, it will be made available automatically at the documentation site.
 
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								## Structure of the docs website
 
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								The site is generated using [`docsify` ](https://docsify.js.org ), and served using GitHub pages.
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								Typically you would not need to change any configuration or build the site locally. In case you are interested, here is how it works:
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								-  The homepage's source for this site is available in [`docs/index.html` ](index.html ).
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								-  We serve this file as a SPA using `docsify`  and GitHub Pages.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								-  The `docsify`  script generates the content of `markdown`  files in `docs`  directory on demand.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								-  The homepage is generated from the [`_coverpage.md` ](_coverpage.md ).
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								-  the sidebar navigation is generated from [`_sidebar.md` ](_sidebar.md ).
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								## Serving the documentation site locally
 
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								Clone freeCodeCamp:
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								```console
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								git clone https://github.com/freeCodeCamp/freeCodeCamp.git
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								docsify serve docs
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								Install `docsify` :
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								```console
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								npm install -g docsify
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								and serve the `/docs`  directory
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								```console
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								docsify serve docs
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								Alternatively, if you have installed freeCodeCamp locally (see the local setup guide), we bundle the CLI with the development tools so you can run any of the below commands as needed from the root of the repo:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								### Serve and launch the documentation site only
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```console
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								npm run docs:serve
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								### Serve the documentation site alongside freeCodeCamp locally:
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```console
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								npm run develop
							 
						 
					
						
							
								
									
										
										
										
											2020-10-02 00:28:40 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-10-22 07:43:50 +05:30 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								>  The documentation site should be available at <http://localhost:3200>