https://github.com/crispgm/weekly
A personal curation of tech articles
https://github.com/crispgm/weekly
articles deliver-articles tech-articles
Last synced: about 1 month ago
JSON representation
A personal curation of tech articles
- Host: GitHub
- URL: https://github.com/crispgm/weekly
- Owner: crispgm
- License: mit
- Created: 2017-07-02T10:34:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T03:26:08.000Z (3 months ago)
- Last Synced: 2025-04-15T14:13:36.678Z (about 1 month ago)
- Topics: articles, deliver-articles, tech-articles
- Language: Ruby
- Homepage: https://crispgm.github.io/weekly/
- Size: 819 KB
- Stars: 9
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Crisp Minimal Weekly](https://crispgm.github.io/weekly/)
[](https://jekyllrb.com)
Personal curation of tech articles. The articles are mostly English and the comments are in Chinese.
Started as a weekly, and now it is without certain interval.
## Install
1. Clone
```
$ git clone https://github.com/crispgm/weekly.git
```
2. Bundler
```
$ bundle install
```
3. Run
```
$ rake serve
```
## Deliver Articles
To deliver articles, please leave comment to [issue](https://github.com/crispgm/weekly/issues) with specific format:
```
/post
- Your awesome title
- https://your-awesome.com/link-to-article.html
- Why you recommend the article in short.
```
### Format Specification
| Field | Type |
|------|-----|
| title | String (Support inline html) |
| link | String |
| comment | String (Support inline html) |
## Work with `rake`
### Create Weekly
```
$ rake weekly:create
```
It will generate scaffolds with date:
```
_weekly/2016-10-09-weekly.md
```
To specify date:
```
$ rake weekly:create[2016-10-09]
```
P.S. In `zsh`, we need to use backslash escape:
```
$ rake weekly:create\[2016-10-09\]
```
### Create GitHub Issue
```
$ ACCESS_TOKEN=your-access-token-here rake weekly:open[2016-10-09]
```
### Import Articles From GitHub Issue
```
$ ACCESS_TOKEN=your-access-token-here rake weekly:import[2016-10-09]
```
### Edit Weekly
Open and edit the latest entry:
```
$ rake weekly:edit-latest
```
To use non-default editors, pass an env variable to `rake`:
```
$ EDITOR=subl rake weekly:edit-latest
```
### Tests
There are several tests to check typos and duplicates errors.
```
$ rake test-weekly
```
It scan all weeklys by default, to specify date:
```
$ rake test-weekly[2016-11-15]
```
For the latest weekly, pass `latest`:
```
$ rake test-weekly[latest]
```
Errors will show with highlighted message to indicates the item:
```
[ERROR] Duplicated name within a weekly found:
Filename: 2016-11-22-weekly.md
Item: 1
>> Name: Google 是如何做到从不宕机的
```
## Press
- [How I build engineering weekly automatically](https://crispgm.com/page/engineering-weekly-automation.html) (In Chinese)
## License
MIT