Configure repositories.txt with the info about where to extract reeco annotations. This is an example:
reeco-framwork/reeco-annotation-schema:main
reeco-framwork/reeco-jekyll:main
reeco-framwork/reeco-website-action:main
reeco-framwork/reeco-web-repo-validator:main
reeco-framwork/reeco-python:mainCommit changes (this should trigger a GH actions that downloads all data and builds the website)
Open an issue and ask for help!
The website is built with Jekyll and hosted on Github pages. It means that one needs to write the code on their machine in a git repository and then push it on Github. Then, Github will render the content as browsable static pages (with CSS/JS).
Jekyll is written in Ruby and Ruby packages are managed with gem. So, as this
page states, you will need to have
Ruby and Gem installed on your computer.
Bundler is also a recommended gem (required?) to work with Jekyll.
Install jekyll and bundler with:
gem install jekyll bundlerGo into the directory and run the following to grab the dependencies (it may be rather long):
bundle installThen, you should be able to run
bundle exec jekyll serve --config=_config.yml,_config-local.yml --livereload
to have Jekyll serve a version of this website (you don't need any other web
server such as Apache or Nginx). A small message should tell you the state of
the rendering process and then invite you to open
http://127.0.0.1:4000/ecosystem/ in your computer.
You may leave this terminal open and start hacking the code with your tool of choice, it will detect the changes and update automatically (a simple refresh of the page in the browser is needed though).
After a satisfactory version is obtained, don't forget to commit (git add <files>,
git commit -m"<message>") your changes and push them on Github (git push), so that
the world may see them. Obvisouly, try to not commit a broken version (ie: which does not
compile with Jekyll).
Then, clone the code from this website in a folder on your computer:
git clone [email protected]:polifonia-project/ecosystem.git