@@ -6,33 +6,33 @@ This is the codebase for my personal blog at [`wiserfirst.com`][], created with
6
6
7
7
## Install
8
8
9
- ### Install Ruby
10
-
11
- Ruby is required to run Jekyll and it can be installed with [ ` asdf ` ] [ ] as
12
- follows:
9
+ ### Clone the Repository
13
10
14
11
``` sh
15
- asdf plugin add ruby
16
- asdf install ruby 2.7.2
17
- asdf global ruby 2.7.2
12
+ git clone
[email protected] :wiserfirst/wiserfirst.github.io.git
13
+ cd wiserfirst.github.io
18
14
```
19
15
20
- ### Clone the Repository
16
+ ### Install Ruby and Nodejs
17
+
18
+ Ruby is required to run Jekyll and Nodejs is needed to run a development
19
+ dependency markdownlint. They can be installed with [ ` asdf ` ] [ ] as
20
+ follows:
21
21
22
22
``` sh
23
- git clone
[email protected] :wiserfirst/wiserfirst.github.io.git
24
- cd wiserfirst.github.io
25
- bundle install
23
+ asdf plugin add ruby
24
+ asdf plugin add nodejs
25
+ # need to run in this directory
26
+ asdf install
26
27
```
27
28
29
+
28
30
### Development Dependencies
29
31
30
32
This app uses the following dependencies during development:
31
33
32
34
- [ markdownlint] [ ] (via [ markdownlint-cli] [ ] ): make sure Markdown syntax
33
35
conforms to community standards
34
- - [ HTMLProofer] [ ] : make sure HTML rendered files are accurate and do not have
35
- broken links etc
36
36
37
37
Install [ Node] [ ] -based dependencies in the following way, and remember to
38
38
re-shim whatever version manager is being used for Node (I use [ ` asdf ` ] [ ] ), or
@@ -44,8 +44,6 @@ npm install --global markdownlint-cli
44
44
asdf reshim nodejs
45
45
```
46
46
47
- HTMLProofer is a Ruby gem and so Bundler will bring it into the project.
48
-
49
47
## Usage
50
48
51
49
### Start blog server
@@ -56,45 +54,17 @@ bundle exec jekyll serve --incremental --drafts --livereload
56
54
57
55
Then, navigate to < http://localhost:4000 >
58
56
59
- ### Monitor files
60
-
61
- This project uses [ Guard] [ ] to monitor file changes.
62
-
63
- Start Guard with the following command:
64
-
65
- ``` sh
66
- bundle exec guard
67
- ```
68
-
69
57
## Theme
70
58
71
59
This blog currently uses the [ Minimal Mistakes] [ ] theme.
72
60
73
61
## Deployment
74
62
75
- This blog is current deployed to [ Netlify] [ ] with [ Travis CI ] [ ] running the
63
+ This blog is current deployed to [ Netlify] [ ] with [ Github Actions ] [ ] running the
76
64
builds.
77
65
78
66
Just push to the ` develop ` branch to trigger a new build and if the build is
79
- successful, site would be built and pushed to the ` release ` branch. Then a new
80
- deployment will be triggered on Netlify, since it monitors the ` release ` branch.
81
-
82
- The only caveat is when there is a new post, the following section in travis
83
- yaml file (which runs ` htmlproofer ` ) needs to be commented out for the build to
84
- pass:
85
-
86
- ``` yaml
87
- - >
88
- bundle exec htmlproofer _site
89
- --allow-hash-href
90
- --assume-extension
91
- --url-ignore "/localhost/,/facebook.com\/sharer\/sharer.php/,#main,/iteye.com\/blog/,/www.williamlong.info/"
92
- --http-status-ignore "999"
93
- --typhoeus-config '{"ssl_verifypeer": false, "ssl_verifyhost": 0}'
94
- ` ` `
95
-
96
- Once the site is deployed with the new post, ` htmlproofer` can be re-enabled
97
- again in a follow up commit.
67
+ successful, the site would be deployed to Netlify.
98
68
99
69
## License
100
70
@@ -111,10 +81,8 @@ under the [MIT license][license-mit-url].
111
81
SPDX-License-Identifier: (MIT AND CC-BY-4.0)
112
82
113
83
[ `asdf` ] : https://github.com/asdf-vm/asdf
114
- [Build Status image] : https://travis-ci.com/wiserfirst/wiserfirst.github.io.svg?branch=develop
115
- [Build Status url] : https://travis-ci.com/github/wiserfirst/wiserfirst.github.io
116
- [Guard] : https://github.com/guard/guard
117
- [HTMLProofer] : https://github.com/gjtorikian/html-proofer
84
+ [ Build Status image ] : https://github.com/wiserfirst/wiserfirst.github.io/actions/workflows/ci.yml/badge.svg
85
+ [ Build Status url ] : https://github.com/wiserfirst/wiserfirst.github.io/actions/workflows/ci.yml
118
86
[ Jekyll ] : https://jekyllrb.com
119
87
[ license-cc-badge ] : https://licensebuttons.net/l/by/4.0/80x15.png
120
88
[ license-cc-url ] : https://creativecommons.org/licenses/by/4.0/legalcode
@@ -127,5 +95,5 @@ SPDX-License-Identifier: (MIT AND CC-BY-4.0)
127
95
[ Netlify Status image ] : https://api.netlify.com/api/v1/badges/e997650f-fd0c-44c5-a6a5-1488dad7d879/deploy-status
128
96
[ Netlify Status url ] : https://app.netlify.com/sites/elastic-villani-588077/deploys
129
97
[ Node ] : https://github.com/nodejs/node
130
- [Travis CI ] : https://travis-ci .com/
98
+ [ Github Actions ] : https://github .com/features/actions
131
99
[ `wiserfirst.com` ] : https://www.wiserfirst.com
0 commit comments