https://github.com/patrick204nqh/mindmaps
A collection of my mindmaps across various subjects, ranging from language learning to technical topics and personal development.
https://github.com/patrick204nqh/mindmaps
Last synced: about 2 months ago
JSON representation
A collection of my mindmaps across various subjects, ranging from language learning to technical topics and personal development.
- Host: GitHub
- URL: https://github.com/patrick204nqh/mindmaps
- Owner: patrick204nqh
- Created: 2024-10-12T03:44:04.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T10:59:18.000Z (6 months ago)
- Last Synced: 2024-10-26T17:58:09.804Z (6 months ago)
- Language: Python
- Homepage: https://patrick204nqh.github.io/mindmaps/
- Size: 10.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mindmap Hub
**Mindmap Hub** is a personal collection of interactive mindmaps covering various topics, including English grammar, vocabulary, and other subjects. These mindmaps are built using **Markmap** and integrated with **MkDocs** for easy visualization and navigation.
## Features
- **Interactive Mindmaps**: Visualize complex concepts with expandable nodes.
- **Grammar and Vocabulary**: English grammar rules and vocabulary mindmaps.
- **Reading, Listening, and Writing Practice**: Resources and exercises for improving English skills.
- **Easily Navigable**: All content is accessible via a clean, organized interface with a search feature.
## How to Use
1. **Navigate the Mindmaps**: The website includes sections for Grammar, Vocabulary, Idioms, and more. Navigate through the sidebar to find the topic of your choice.
2. **View Interactive Mindmaps**: Click on any topic to view the corresponding mindmap. You can zoom in and out, collapse, or expand nodes for detailed exploration.
3. **Practice and Learn**: Many sections include practice exercises to test your knowledge.
## Getting Started Locally
To run the site locally:
1. Clone this repository:
```bash
git clone https://github.com/yourusername/mindmap-hub.git
cd mindmap-hub
```
2. Install MkDocs and the required plugins:
```bash
pip install mkdocs mkdocs-material mkdocs-markmap
```
3. Serve the site locally:
```bash
mkdocs serve
```
The site will be available at `http://127.0.0.1:8000/`.
## Deployment
To deploy the site to GitHub Pages:
1. Commit any changes:
```bash
git add .
git commit -m "Update site"
```
2. Deploy using MkDocs:
```bash
mkdocs gh-deploy
```
## Contributing
This is a personal project, but feel free to suggest improvements or new ideas via pull requests or issues.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.