| 
									
										
										
										
											2020-02-25 14:41:14 -08:00
										 |  |  | Building the Solana Docs | 
					
						
							| 
									
										
										
										
											2018-12-13 10:25:25 -07:00
										 |  |  | --- | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-02-26 23:11:38 +08:00
										 |  |  | Install dependencies, build, and test the docs: | 
					
						
							| 
									
										
										
										
											2018-12-13 10:25:25 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							| 
									
										
										
										
											2020-02-25 14:41:14 -08:00
										 |  |  | $ brew install coreutils | 
					
						
							|  |  |  | $ brew install mscgen | 
					
						
							| 
									
										
										
										
											2020-05-13 09:08:25 -07:00
										 |  |  | $ cargo install svgbob_cli | 
					
						
							|  |  |  | $ cargo install mdbook-linkcheck | 
					
						
							|  |  |  | $ cargo install mdbook | 
					
						
							| 
									
										
										
										
											2018-12-14 15:55:16 -08:00
										 |  |  | $ ./build.sh | 
					
						
							| 
									
										
										
										
											2018-12-13 10:25:25 -07:00
										 |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Run any Rust tests in the markdown: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							| 
									
										
										
										
											2018-12-14 15:55:16 -08:00
										 |  |  | $ make test | 
					
						
							| 
									
										
										
										
											2018-12-13 10:25:25 -07:00
										 |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Render markdown as HTML: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							| 
									
										
										
										
											2018-12-14 15:55:16 -08:00
										 |  |  | $ make build | 
					
						
							| 
									
										
										
										
											2018-12-13 10:25:25 -07:00
										 |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-02-26 23:11:38 +08:00
										 |  |  | Render and view the docs: | 
					
						
							| 
									
										
										
										
											2018-12-13 10:25:25 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							| 
									
										
										
										
											2018-12-14 15:55:16 -08:00
										 |  |  | $ make open | 
					
						
							| 
									
										
										
										
											2018-12-13 10:25:25 -07:00
										 |  |  | ``` |