Skip to content

Commit 0a5fd51

Browse files
committed
update Readme
1 parent 2794e20 commit 0a5fd51

File tree

1 file changed

+18
-50
lines changed

1 file changed

+18
-50
lines changed

README.md

Lines changed: 18 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,33 @@ This is the codebase for my personal blog at [`wiserfirst.com`][], created with
66

77
## Install
88

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
1310

1411
```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
1814
```
1915

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:
2121

2222
```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
2627
```
2728

29+
2830
### Development Dependencies
2931

3032
This app uses the following dependencies during development:
3133

3234
- [markdownlint][] (via [markdownlint-cli][]): make sure Markdown syntax
3335
conforms to community standards
34-
- [HTMLProofer][]: make sure HTML rendered files are accurate and do not have
35-
broken links etc
3636

3737
Install [Node][]-based dependencies in the following way, and remember to
3838
re-shim whatever version manager is being used for Node (I use [`asdf`][]), or
@@ -44,8 +44,6 @@ npm install --global markdownlint-cli
4444
asdf reshim nodejs
4545
```
4646

47-
HTMLProofer is a Ruby gem and so Bundler will bring it into the project.
48-
4947
## Usage
5048

5149
### Start blog server
@@ -56,45 +54,17 @@ bundle exec jekyll serve --incremental --drafts --livereload
5654

5755
Then, navigate to <http://localhost:4000>
5856

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-
6957
## Theme
7058

7159
This blog currently uses the [Minimal Mistakes][] theme.
7260

7361
## Deployment
7462

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
7664
builds.
7765

7866
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.
9868

9969
## License
10070

@@ -111,10 +81,8 @@ under the [MIT license][license-mit-url].
11181
SPDX-License-Identifier: (MIT AND CC-BY-4.0)
11282

11383
[`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
11886
[Jekyll]: https://jekyllrb.com
11987
[license-cc-badge]: https://licensebuttons.net/l/by/4.0/80x15.png
12088
[license-cc-url]: https://creativecommons.org/licenses/by/4.0/legalcode
@@ -127,5 +95,5 @@ SPDX-License-Identifier: (MIT AND CC-BY-4.0)
12795
[Netlify Status image]: https://api.netlify.com/api/v1/badges/e997650f-fd0c-44c5-a6a5-1488dad7d879/deploy-status
12896
[Netlify Status url]: https://app.netlify.com/sites/elastic-villani-588077/deploys
12997
[Node]: https://github.com/nodejs/node
130-
[Travis CI]: https://travis-ci.com/
98+
[Github Actions]: https://github.com/features/actions
13199
[`wiserfirst.com`]: https://www.wiserfirst.com

0 commit comments

Comments
 (0)