mirror of
				https://gitlab.com/qemu-project/seabios.git
				synced 2025-10-30 07:58:38 +08:00 
			
		
		
		
	docs: Add mkdocs build tools for building the seabios.org website
Support converting the existing SeaBIOS documentation into a website using the mkdocs tool. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
		
							
								
								
									
										12
									
								
								docs/_website/README
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								docs/_website/README
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,12 @@ | ||||
| This directory defines the https://www.seabios.org/ website. | ||||
|  | ||||
| To test deploy the main site locally one can use commands similar to | ||||
| the following: | ||||
|  | ||||
| virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/seabios/docs/_website/mkdocs-requirements.txt | ||||
| cd ~/seabios && ~/mkdocs-env/bin/mkdocs serve --config-file ~/seabios/docs/_website/mkdocs.yml -a 0.0.0.0:8000 | ||||
|  | ||||
| To build the main html run something similar to: | ||||
|  | ||||
| virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/seabios/docs/_website/mkdocs-requirements.txt | ||||
| ~/mkdocs-env/bin/mkdocs build -f ~/seabios/docs/_website/mkdocs.yml -d ~/seabios-site/ | ||||
							
								
								
									
										10
									
								
								docs/_website/mkdocs-requirements.txt
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								docs/_website/mkdocs-requirements.txt
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,10 @@ | ||||
| # Python virtualenv module requirements for mkdocs | ||||
| jinja2==3.1.6 | ||||
| mkdocs==1.2.4 | ||||
| mkdocs-material==8.1.3 | ||||
| mkdocs-simple-hooks==0.1.3 | ||||
| mkdocs-exclude==1.0.2 | ||||
| mdx-truly-sane-lists==1.3 | ||||
| mdx-breakless-lists==1.0.1 | ||||
| py-gfm==2.0.0 | ||||
| markdown==3.7 | ||||
							
								
								
									
										62
									
								
								docs/_website/mkdocs.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										62
									
								
								docs/_website/mkdocs.yml
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,62 @@ | ||||
| # Main configuration file for mkdocs generation of www.seabios.org website | ||||
|  | ||||
| # Site and directory configuration | ||||
| site_name: SeaBIOS documentation | ||||
| repo_url: https://git.seabios.org/ | ||||
| use_directory_urls: False | ||||
| docs_dir: '../' | ||||
|  | ||||
| # Custom markdown dialect settings | ||||
| markdown_extensions: | ||||
|   - toc: | ||||
|       permalink: True | ||||
|       toc_depth: 6 | ||||
|   - attr_list | ||||
|   - mdx_partial_gfm | ||||
|   - mdx_truly_sane_lists | ||||
|   - mdx_breakless_lists | ||||
| plugins: | ||||
|   search: | ||||
|     lang: en | ||||
|  | ||||
| # Website layout configuration (using mkdocs-material theme) | ||||
| theme: | ||||
|   name: material | ||||
|   palette: | ||||
|     - media: "(prefers-color-scheme: light)" | ||||
|       scheme: default | ||||
|       primary: white | ||||
|       accent: blue | ||||
|       toggle: | ||||
|         icon: material/lightbulb | ||||
|         name: Switch to dark mode | ||||
|     - media: "(prefers-color-scheme: dark)" | ||||
|       scheme: slate | ||||
|       primary: grey | ||||
|       accent: light blue | ||||
|       toggle: | ||||
|         icon: material/lightbulb-outline | ||||
|         name: Switch to light mode | ||||
|   features: | ||||
|       - navigation.top | ||||
|       - search.suggest | ||||
|       - search.highlight | ||||
|       - search.share | ||||
|   language: en | ||||
|  | ||||
| # Navigation hierarchy | ||||
| nav: | ||||
|   - Download.md | ||||
|   - Releases.md | ||||
|   - Mailinglist.md | ||||
|   - Developer Documentation: | ||||
|     - Developer_Documentation.md | ||||
|     - Build_overview.md | ||||
|     - Memory_Model.md | ||||
|     - Execution_and_code_flow.md | ||||
|     - Linking_overview.md | ||||
|     - Runtime_config.md | ||||
|     - Debugging.md | ||||
|     - Contributing.md | ||||
|     - Developer_links.md | ||||
|   - SeaVGABIOS.md | ||||
		Reference in New Issue
	
	Block a user
	 Kevin O'Connor
					Kevin O'Connor