Skip to content

Commit c840d02

Browse files
committed
contributing
1 parent f1706c0 commit c840d02

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Docs
2+
3+
4+
## Pull The Repository
5+
6+
* Make changes to the `_docs` file
7+
* And the config file `mkdocs.yml`
8+
* Run **chmod u+x update_docs.sh**
9+
* Run the `update_docs.sh`

update_docs.sh

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#!/bin/bash
2+
3+
COLOR="\e[42m"
4+
END="\e[0m"
5+
6+
echo -e "$COLOR git rm -r docs --force $END"
7+
git rm -r docs --force
8+
echo -e "$COLOR git commit -m 'removed old docs' $END"
9+
git commit -m "Removed Old Docs"
10+
echo -e "$COLOR git push -u origin master $END"
11+
git push -u origin master
12+
13+
echo -e "$COLOR mkdocs build $END"
14+
mkdocs build
15+
echo -e "$COLOR touch docs/CNAME $END"
16+
touch docs/CNAME
17+
echo "$COLOR add CNAME $END"
18+
echo "repo.twitivity.dev" >> docs/CNAME
19+
echo -e "$COLOR git add docs $END"
20+
git add docs
21+
echo -e "$COLOR git commit -m 'updated docs' $END"
22+
git commit -m "docs updated"
23+
echo -e "$COLOR git push -u origin master $END"
24+
git push -u origin master
25+
echo -e "$COLOR DONE. $END"

0 commit comments

Comments
 (0)