Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@ Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
Style/TernaryParentheses:
EnforcedStyle: require_parentheses_when_complex

Layout/BlockAlignment:
EnforcedStyleAlignWith: start_of_block
2 changes: 1 addition & 1 deletion .ruby-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.3.2
3.3.11
2 changes: 1 addition & 1 deletion .vuepress/components/EditPageLink.vue
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default {
},
editUrl () {
if (!this.$page || !this.$page.frontmatter.source) return null
return this.$page.frontmatter.source.replace('/blob/', '/edit/').replace('/developer/', '/developers/')
return this.$page.frontmatter.source.replace('/blob/', '/edit/')
}
}
}
Expand Down
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This website is made with [VuePress](https://vuepress.vuejs.org/).
It will be installed as part of the dev dependencies.
For the used version of vuepress to work correctly, Node.js 16.20.0 or **older** is needed.
Alternatively on newer versions [the legacy OpenSSL provider can be enabled as described in this StackOverflow thread](https://stackoverflow.com/questions/69692842/error-message-error0308010cdigital-envelope-routinesunsupported).
For the Ruby scripts used by the website build, Ruby 3.3.2 is needed.
For the Ruby scripts used by the website build, Ruby 3.3.11 is needed.
If you are using a Node.js version manager like [fnm](https://github.com/Schniz/fnm), the provided `.node-version` file should automatically set the correct Node.js version needed.
If you are using a Ruby version manager like [rvm](https://rvm.io/), running `rvm use` should automatically set the correct version according to the `.ruby-version` file.

Expand All @@ -24,23 +24,23 @@ This chapter describes how to setup a local environment to be able to build the

The following has been tested on Linux and MacOS (Windows seems to have a few minors that prevent the script to run completely).

#### Ruby 3.3.2
#### Ruby 3.3.11

It is highly recommended to use the [Ruby Version Manager (RVM)](https://rvm.io).
Once installed it will help to automatically download and configure `Ruby`:

```bash
$ rvm install "ruby-3.3.2"
$ rvm install "ruby-3.3.11"
$ rvm use
Using /home/foo/.rvm/gems/ruby-3.3.2
Using /home/foo/.rvm/gems/ruby-3.3.11
```

If there are no binary packages available for your distribution, `rvm` will compile `Ruby` from the source code:

```bash
$ rvm install "ruby-3.3.2"
$ rvm install "ruby-3.3.11"
Searching for binary rubies, this might take some time.
No binary rubies available for: ubuntu/22.04/x86_64/ruby-3.3.2.
No binary rubies available for: ubuntu/22.04/x86_64/ruby-3.3.11.
Continuing with compilation.
# ...
```
Expand Down Expand Up @@ -79,6 +79,5 @@ This will:

1. Run `ruby prepare-docs.rb` as above.
2. Run `vuepress build` which will output the final static files in `vuepress`.
3. Run `ruby postbuild.rb` which removes all prefetch directives inserted by VuePress from `index.html`, which optimizes the initial load performance.

The complete build will take between 2 and 5 minutes.
24 changes: 13 additions & 11 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
GEM
remote: https://rubygems.org/
specs:
ast (2.4.2)
json (2.7.2)
language_server-protocol (3.17.0.3)
parallel (1.25.1)
parser (3.3.2.0)
ast (2.4.3)
json (2.19.5)
language_server-protocol (3.17.0.5)
parallel (1.28.0)
parser (3.3.11.1)
ast (~> 2.4.1)
racc
racc (1.8.0)
prism (1.9.0)
racc (1.8.1)
rainbow (3.1.1)
regexp_parser (2.9.2)
rexml (3.3.9)
regexp_parser (2.12.0)
rexml (3.4.4)
rubocop (1.64.1)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
Expand All @@ -23,10 +24,11 @@ GEM
rubocop-ast (>= 1.31.1, < 2.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 2.4.0, < 3.0)
rubocop-ast (1.31.3)
parser (>= 3.3.1.0)
rubocop-ast (1.49.1)
parser (>= 3.3.7.2)
prism (~> 1.7)
ruby-progressbar (1.13.0)
unicode-display_width (2.5.0)
unicode-display_width (2.6.0)

PLATFORMS
aarch64-linux
Expand Down
85 changes: 0 additions & 85 deletions add-blog-meta.rb

This file was deleted.

79 changes: 0 additions & 79 deletions generate_iconset_doc.rb

This file was deleted.

2 changes: 2 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[build.environment]
MISE_RUBY_COMPILE = "false"
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@
"scripts": {
"predev": "npm install && npx update-browserslist-db@latest",
"dev": "npx vuepress dev",
"prepare-docs": "ruby prepare-docs.rb $ARGUMENTS",
"add-blog-meta": "ruby add-blog-meta.rb",
"build": "npm run prepare-docs && ruby add-blog-meta.rb && vuepress build .",
"prepare-docs": "ruby scripts/prepare-docs.rb $ARGUMENTS",
"add-blog-meta": "ruby scripts/add-blog-meta.rb",
"build": "npm run prepare-docs && ruby scripts/add-blog-meta.rb && vuepress build .",
"build-only": "vuepress build .",
"prebuild-local": "npm run prepare-docs",
"build-local": "npm run dev --silent",
Expand Down
9 changes: 0 additions & 9 deletions postbuild.rb

This file was deleted.

Loading