https://github.com/atomvm/atomvm_www

Generate a website serving the tutorials and guides featured on www.atomvm.net
https://github.com/atomvm/atomvm_www

atomvm website

Last synced: 5 days ago
JSON representation

Generate a website serving the tutorials and guides featured on www.atomvm.net

• Host: GitHub
• URL: https://github.com/atomvm/atomvm_www
• Owner: atomvm
• Created: 2021-11-13T20:54:15.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-21T21:50:16.000Z (7 months ago)
• Last Synced: 2024-04-22T01:55:34.725Z (7 months ago)
• Topics: atomvm, website
• Language: Ruby
• Homepage: https://www.atomvm.net
• Size: 1.7 GB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Prerequisites

To build this website, you will need:

* [Ruby 2.7](https://www.ruby-lang.org/en/)

* [Bundler](https://bundler.io)

# Instructions

Change your working directory to the directory containing this README:

    cd 

[Optional] We recommend installing all the needed Ruby gems locally (by convention, under `vendor/bundle`):

    bundle config set --local path 'vendor/bundle'

Install all the needed gems.  This may take some time to complete.  Be patient.

    bundle install

Serve up your site!

    bundle exec jekyll serve [--host ] [--port ]

or build the website:

    bundle exec jekyll build [-d ] [--watch]

# Add a News Post

To post a new article add a file to the _posts directory in the format:

`YYYY-MM-DD-{title}.md`

with a title section like:

```

---

layout: post

title: {Your Headline}

excerpt_separator: 

---

```

followed by the news post in markdown format.

If you are posting a long article you can tell where to cut off the introduction that is displayed in the news section, leaving the full article available by following the article link, by placing a line containing:

``

All content following the above line will only be included in the full article, content before will be displayed as a description on the `atomvm.net/news` page.