Skip to content

Commit 5ca9fc2

Browse files
yashlambayashlamba
committed
docs: Intialized MkDocs
1 parent c5c9987 commit 5ca9fc2

12 files changed

+177
-54
lines changed

‎.flutter-plugins-dependencies

-1
This file was deleted.

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
.buildlog/
99
.history
1010
.svn/
11+
/site/
1112

1213
# IntelliJ related
1314
*.iml

‎.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "site"]
2+
path = site
3+
url = https://github.com/cod-ed/simulate.git
4+
branch = gh-pages

‎deploy.sh

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#!/bin/sh
2+
3+
# If a command fails then the deploy stops
4+
set -e
5+
6+
printf "\033[0;32mDeploying updates to GitHub...\033[0m\n"
7+
8+
# Build the project.
9+
mkdocs build # if using a theme, replace with `hugo -t <YOURTHEME>`
10+
11+
# Go To Public folder
12+
cd site
13+
14+
# Add changes to git.
15+
git add .
16+
17+
# Commit changes.
18+
msg="rebuilding site $(date)"
19+
if [ -n "$*" ]; then
20+
msg="$*"
21+
fi
22+
git commit -m "$msg"
23+
24+
# Push source and build repos.
25+
git push origin gh-pages

‎docs/CONTRIBUTING.md

-39
This file was deleted.

‎docs/CUSTOM_WIDGETS.md

-3
This file was deleted.

‎docs/SIMULATIONS.md

-11
This file was deleted.

‎docs/contributing.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing
2+
!!! note ""
3+
Before contributing, we highly recommend introducing yourself and your ideas on [gitter](https://gitter.im/codEd-org/simulate#).
4+
5+
## Setting Up Simulate
6+
7+
1. Make sure you have Flutter installed (https://flutter.dev/docs/get-started/install)
8+
2. Fork the repository
9+
3. Clone the forked repository:
10+
```
11+
git clone https://github.com/[YOUR USERNAME]/simulate.git
12+
```
13+
4. Connect a device or run an emulator (Make sure your connected device has USB Debugging enabled)
14+
5. Navigate to the project directory and Run:
15+
```bash
16+
cd simulate
17+
flutter run
18+
```
19+
20+
---
21+
22+
## Building your stuff
23+
24+
#### Fixing a bug:
25+
26+
1. Open an issue or report on [gitter](https://gitter.im/codEd-org/simulate#)
27+
2. Make a new branch
28+
```console
29+
git checkout -b [BRANCH NAME]
30+
```
31+
3. Fix the bug, push and open a pull request
32+
33+
#### Adding a new Simulation:
34+
35+
1. Discuss the idea first on [gitter](https://gitter.im/codEd-org/simulate#) or just open an issue with the template.
36+
2. Discuss with the maintainers and get a simulation ID assigned.
37+
3. Build your simulation and open a PR!
38+
39+
---
40+
41+
## Setting Up Docs
42+
43+
1. Install mkdocs
44+
```bash
45+
python3 -m pip install mkdocs
46+
```
47+
2. Check the installations by:
48+
```bash
49+
mkdocs --version
50+
```
51+
52+
!!! warning ""
53+
If this doesn't work, try restarting the terminal
54+
55+
3. Use the below command to host the documentation on local server
56+
```bash
57+
mkdocs serve
58+
```
59+
{== MkDocs supports live reload so you don't have to run the server again and again. Just make your changes in the docs and you'll see the change immediately. ==}
60+
4. All the documentation is present in the `docs` directory.
61+
62+
---
63+
64+
!!! quote ""
65+
*Don't hesitate in asking questions, it's a part of learning and everyone is here to help.*

‎docs/doc/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# TODO

‎docs/index.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Simulate
2+
[![Gitter](https://badges.gitter.im/codEd-org/simulate.svg)](https://gitter.im/codEd-org/simulate?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
3+
4+
Welcome to Simulate! Simulate is a collection of simulations and visualizations from various domains like mathematics, physics, computer science etc. in a cross platform app made using Flutter. The outcomes of these simulations mostly are really smooth (thanks to Flutter) and extremely beautiful (thanks to mathematics/sciences behind it). You can take a peek [here](simulations/).
5+
6+
---
7+
8+
## New to Simulate?
9+
10+
You can start by introducing yourself and your ideas on [gitter](https://gitter.im/codEd-org/simulate).
11+
12+
Interested in Contributing? Check the guidelines [here](contributing/).
13+
14+
All further information about the can be found in the [documentation](doc/).

‎docs/simulations/index.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Simulations
2+
3+
| Simulation ID | Simulation Name | Infolink | Preview |
4+
| :-----------: | :---------------: | :------: | :-----: |
5+
| 0 | Toothpick Pattern | [Link](https://en.wikipedia.org/wiki/Toothpick_sequence) | ![](https://raw.githubusercontent.com/cod-ed/simulate/assets/previews/gifs/ToothpickPattern.gif) |
6+
| 1 | Langton's Ant | [Link](https://en.wikipedia.org/wiki/Langton%27s_ant) | ![](https://raw.githubusercontent.com/cod-ed/simulate/assets/previews/gifs/LangtonsAnt.gif) |
7+
| 2 | Bubble Sort (Bars) | [Link](https://en.wikipedia.org/wiki/Bubble_sort) | ![](https://raw.githubusercontent.com/cod-ed/simulate/assets/previews/gifs/BubbleSortBars.gif) |
8+
| 3 | Insertion Sort (Bars) | [Link](https://en.wikipedia.org/wiki/Insertion_sort) | ![](https://raw.githubusercontent.com/cod-ed/simulate/assets/previews/gifs/InsertionSortBars.gif) |
9+
| 4 | Rose Pattern | [Link](https://en.wikipedia.org/wiki/Rose_(mathematics)) | ![](https://raw.githubusercontent.com/cod-ed/simulate/assets/previews/gifs/RosePattern.gif) |
10+
| 5 | Fourier Series | [Link](https://en.wikipedia.org/wiki/Fourier_series) | ![](https://raw.githubusercontent.com/cod-ed/simulate/assets/previews/gifs/FourierSeries.gif) |
11+
| 6 | Pi Approximation (Monte Carlo Method) | [Link](https://en.wikipedia.org/wiki/Monte_Carlo_method) | ![](https://raw.githubusercontent.com/cod-ed/simulate/assets/previews/gifs/PiMonteCarlo.gif) |

‎mkdocs.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
site_name: 'Simulate'
2+
site_description: 'Official site for Simulate'
3+
site_author: 'Yash Lamba'
4+
site_url: 'https://cod-ed.github.io/simulate/'
5+
6+
# Repository
7+
repo_name: 'cod-ed/simulate'
8+
repo_url: 'https://github.com/cod-ed/simulate'
9+
10+
# Copyright
11+
nav:
12+
- Home: 'index.md'
13+
- Contributing: 'contributing.md'
14+
- Documentation:
15+
- Home: 'doc/index.md'
16+
- Simulations:
17+
- All Simulations: 'simulations/index.md'
18+
# Configuration
19+
theme:
20+
name: 'material'
21+
feature:
22+
tabs: true
23+
palette:
24+
primary: 'black'
25+
accent: 'white'
26+
font:
27+
text: 'Ubuntu'
28+
code: 'Ubuntu Mono'
29+
logo:
30+
icon: 'library_books'
31+
32+
# Customization
33+
34+
# Extensions
35+
markdown_extensions:
36+
- admonition
37+
- codehilite:
38+
guess_lang: false
39+
- toc:
40+
permalink: true
41+
- pymdownx.arithmatex
42+
- pymdownx.betterem:
43+
smart_enable: all
44+
- pymdownx.caret
45+
- pymdownx.critic
46+
- pymdownx.details
47+
- pymdownx.emoji:
48+
emoji_generator: !!python/name:pymdownx.emoji.to_svg
49+
- pymdownx.inlinehilite
50+
- pymdownx.magiclink
51+
- pymdownx.mark
52+
- pymdownx.smartsymbols
53+
- pymdownx.superfences
54+
- pymdownx.tasklist:
55+
custom_checkbox: true
56+
- pymdownx.tilde

0 commit comments

Comments
 (0)