stellarvector / blog

Stellar Vector Blog

Stellar Vector Blog

Welcome!

When adding or editing a writeup, please use the instructions below.

Adding a writeup

When adding a writeup, please use the included sv-commands.sh and the function sv-add-writeup in it to generate the writeup template.

Usage:

1. source ./sv-commands.sh
2. sv-add-writer (if you haven't done this yet previously)
3. Enter the information requested in the prompts
4. sv-add-writeup
5. Enter the information requested in the prompts
6. Edit ONLY the file the output points you to or the assets directory
7. Submit a PR to the repo
8. We thank you for your contribution!!!

You CAN write a second writeup if there is already one for a specific challenge.

For errors in the script or other parts of the site, submit an issue and possibly a separate pull request. Do not fix issues in writeup-submission PRs!

Editing a writeup

When editing a writeup, correct the writeup content (or title) and add or overwrite the last_edit_date! Also add a small changelog message at the end of the writeup explaining what changed on that date.

Running locally

It should be as easy as (you might need to use sudo):

1. bundle install
2. bundle exec jekyll serve
3. go to http://127.0.0.1:4000/

blog's Issues

Writeup creator not working

Just run sv-add-writeup and got

find: ‘./_writeups//’: No such file or directory
mkdir: cannot create directory ‘./_writeups//2023/’: No such file or directory
bash: ./_writeups//2023/index.md: No such file or directory
find: ‘./_writeups/2023/’: No such file or directory
mkdir: cannot create directory ‘./_writeups/2023/downunderctf/’: No such file or directory
bash: ./_writeups/2023/downunderctf/index.md: No such file or directory
bash: ./_writeups/2023/downunderctf/abpq-rsa-1.md: No such file or directory

Mostly typos: in the code we have BASE_PATH="./_writeups/" which creates some problems like the double backslash in the second line, however other times we have $BASE_PATH$YEAR which suggests that $BASEPATH should actually have the final backslash.
However I don't know what is the intended behaviour: do we want _writeups/2023/ctf_name or _writeups2023/ctfname?
Also the fact that _writeup does not exists creates some issues but these are solvable just creating the folder the first time - unless some index file i do not know about is supposed to be there.

Dependencies missing when running jekyll locally

I tried to fork and run the blog locally, and I run into a couple of issues. First of all, jekyll serve doesn't seem to work, but the error already suggests to use bundle exec jekyll serve (or bundle exec jekyll s) instead.
However also bundle exec returns an error cannot load such file -- jekyll-include-cache (LoadError). I solved this adding the line gem 'jekyll-include-cache to Gemfile, then running bundle update --bundler and bundle install.
After that another missing dependence: cannot load such file -- webrick (LoadError). For this bundle add webrick worked (I think is equivalent to add to the Gemfile the line like above). bundle exec jekyll s works now, but I don't want to pr this since I'm quite new to gem and I don't want to mess up with the online repo.

For the future: support to matjax?

https://just-the-docs.github.io/just-the-docs-tests/components/math/index/
Right now mathjax (or similar) is not supported, in the future it may be a helpful addition