Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hedzr/notes-hi

template repo for building site from markdown docs/notes
https://github.com/hedzr/notes-hi

mkdocs mkdocs-material mkdocs-site template template-repo template-repository

Last synced: about 2 months ago
JSON representation

template repo for building site from markdown docs/notes

Host: GitHub
URL: https://github.com/hedzr/notes-hi
Owner: hedzr
Created: 2020-04-24T06:45:34.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2020-12-08T16:37:33.000Z (about 4 years ago)
Last Synced: 2024-03-02T21:38:18.512Z (10 months ago)
Topics: mkdocs, mkdocs-material, mkdocs-site, template, template-repo, template-repository
Language: Shell
Homepage: https://hedzr.github.io/notes-hi/
Size: 681 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# hedzr/notes-hi

![CI](https://github.com/hedzr/notes-hi/workflows/CI/badge.svg)

A template repository for building a docs site from markdown docs/notes.

## fast guide:

1. All you have to do is click the Use this template button upon this page.
2. run!

## Using command-line:

### new repo

1. clone notes-hi as a template
```bash
# clone notes-hi as a template
git clone https://github.com/hedzr/notes-hi.git new-repo
cd new-repo
git push [email protected]:yourname/new-repo.git +master:master
```

2. clone the `new-repo` to your working directory:
```bash
# in the working directory of your new-repo
cd ~/work
git clone [email protected]:yourname/new-repo.git
cd new-repo
```

3. publish as gh-pages:
1. via `build.sh`:
```bash
# ./build.sh prepare_gh_pages_branch
git checkout --orphan gh-pages
rm -rf * .gitignore docs site 2>/dev/null
touch README.md && git add . && git commit -m 'initial gh-pages commit' && git push origin gh-pages
git checkout master && \
git branch -D gh-pages && \
git subtree add --prefix=site origin gh-pages

#rm -rf site 2>/dev/null
#git subtree add --prefix=site origin gh-pages
```
> If error occurs at `git subtree add ...`: `prefix 'site' already exists`, try this:
> ```bash
> git subtree split --rejoin --prefix=site origin gh-pages
> ```
2. via mkdocs gh-deploy
```bash
mkdocs gh-deploy
```