https://github.com/joyeecheung/diary

Reads diaries written in markdown from a git submodule, and generates a static site for it.
https://github.com/joyeecheung/diary

Last synced: 26 days ago
JSON representation

Reads diaries written in markdown from a git submodule, and generates a static site for it.

• Host: GitHub
• URL: https://github.com/joyeecheung/diary
• Owner: joyeecheung
• Created: 2015-05-17T10:36:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-31T07:57:50.000Z (over 8 years ago)
• Last Synced: 2024-08-01T02:28:50.153Z (3 months ago)
• Language: JavaScript
• Homepage: http://joyeecheung.github.io/diary/
• Size: 876 KB
• Stars: 84
• Watchers: 4
• Forks: 32
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# A Diary Generator

Reads diaries written in markdown from a git submodule, and generates a static site for it. ([Demo](http://joyeecheung.github.io/diary/))

Requires Node 4.x and above.

## About the repos

The markdown files for the diaries can be kept under another repo named `YYYY/MM/DDDD.md`([Example](https://github.com/joyeecheung/my-tech-diary)).

## Build

1. Run `npm install` to install the dependencies

2. Configure `config.js`

3. `git checkout -b yourname` for your own branch(so you can keep the master branch intact in case you want to receive updates)

4. `git rm diary` to remove the old submodule for diaries

5. `git submodule add git://new/submodule.git diary` to add your own submodule

6. Commit the changes (to your own branch) if you want.

7. Run `gulp build` to generate the static site (placed under `dist`).

8. Run `gulp server` and visit `http://localhost:8000/diary` if you want to see it hosted locally(make sure the port 8000 is not taken).

You can receive updates by pulling updates into your master branch, and check them out to your own branch.

## Deploy to GitHub Pages

1. Set up the SSH git remote `origin` for the project.

2. After building the web page, run `gulp deploy`.

3. Everything under dist will be pushed to the remote repo's gh-pages branch.

## Develop

1. Make sure port 35729(for livereload) and 8000(for the local server) are available.

2. Run `gulp`, then visit `http://localhost:8000/diary`.

3. Start development!

4. When you are done, you can checkout the changes from your branch to the master branch, and send in a pull request if you want.

## TODO

- [ ] Write a calendar to replace pikaday

- [ ] Add "previous" and "next" button to the diary pages

## LICENSE

(MIT License)

Copyright (c) 2015 Joyee Cheung

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.