The comprehensive wiki and knowledge base for New Dawn, an Ultima Online server.
Live Site: https://codex.uonewdawn.com
This repository contains the source for the New Dawn Codex, built with MkDocs and the Material for MkDocs theme. We welcome contributions from the community!
When you submit changes via pull request, they will be automatically deployed to the live site once merged to the main branch.
Don't want to set up a local environment? You can contribute directly through GitHub's web interface:
- Navigate to the file you want to edit in the repository
- Click the pencil icon (✏️) in the top-right corner of the file view
- Make your changes in the GitHub editor
- Preview your changes using the "Preview" tab
- Propose changes by filling out the commit message at the bottom
- Create a pull request - GitHub will automatically fork the repo and create a PR for you
This is perfect for fixing typos, updating content, or making small improvements without needing to install anything locally!
- Python 3.11 or higher
- pip (Python package manager)
- Fork and clone the repository:
git clone https://github.com/UONewDawn/Codex.git
cd Codex- Create a virtual environment (recommended):
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate- Install dependencies:
pip install -r requirements.txt- Run the development server:
mkdocs serve- Open your browser to http://localhost:8000
The site will automatically reload when you make changes to the documentation!
Try to contain you changes within the existing structure. If you're unsure, please reach out.
- Create a new
.mdfile in the appropriate directory underdocs/ - Add the page to the navigation in
mkdocs.yml - Write your content using Markdown
- Test locally with
mkdocs serve
- Find the
.mdfile in thedocs/directory - Make your changes
- Save and preview in your browser (auto-reloads)
- Verify everything looks correct
The site supports extended Markdown with special features:
# Main Heading
## Sub Heading
**Bold** and *italic* text
[Link text](url)
- Bullet lists
1. Numbered lists!!! note "Title"
Important information here
!!! tip "Pro Tip"
Helpful advice
!!! warning "Watch Out"
Warning message
!!! danger "Critical"
Important warning<div class="grid cards" markdown>
- :material-icon:{ .lg .middle } __Title__
---
Description text
[:octicons-arrow-right-24: Link](url)
</div>| Column 1 | Column 2 |
|----------|----------|
| Data | Data |- Fork the repository on GitHub
- Create a branch for your changes:
git checkout -b my-new-content - Make your edits in the
docs/directory - Test locally with
mkdocs serve - Commit your changes:
git commit -am 'Add new guide' - Push to your fork:
git push origin my-new-content - Submit a pull request on GitHub
Your changes will be reviewed and, once approved, automatically deployed to the live site!
- Run
pip install -r requirements.txt - Check that you're in the virtual environment
- Check
mkdocs.ymlfor syntax errors - Ensure all paths in navigation exist
- Use relative paths:
../page.mdnot/page.md - Verify linked files exist
- Stop any other instances of
mkdocs serve - Or use a different port:
mkdocs serve -a localhost:8001
- Hard refresh your browser (Ctrl+Shift+R or Cmd+Shift+R)
- Check for syntax errors in your Markdown
- MkDocs - Static site generator
- Material for MkDocs - Theme
- Python Markdown Extensions - Enhanced Markdown features
This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) License.
- Attribution: You must give appropriate credit if you use this content.
- ShareAlike: If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
Disclaimer: Ultima Online™ is a trademark of Electronic Arts Inc. This project is a fan-made resource and is not affiliated with Electronic Arts or Broadsword.
Built for the New Dawn community
