Code Reading Club information site

Published site Code of conduct

Adding or editing content

Content is provided by markdown files

• index page
• Blog pages
• Blogs can be in draft (only visible in a dev environment) by adding "draft": true to the blog's .md file

Authors are defined with name, avatar and bio required

• list of authors
• Add a new author by adding a new record to the all list like this:

all =
    [ { name = "Author Name"
      , avatar = Pages.images.author.jpegname
      , bio = "Brief biographical info"
      }
    , { name = "Another Author"
      , avatar = Pages.images.author.anotherjpegname
      , bio = "Some biographical info"
      }
    ]

Images files need to be added before they can be used by authors and articles

• author images
• article images

Deploy to GitHub pages with Travis

We're using Travis.

• On every push to the repo, Travis will build and run tests
• On every push or merge to main branch, Travis will deploy to gh-pages

Encrypted vars can be added to .travis.yml using the travis cli tools as described in the travis docs. Currently configured with GITHUB_TOKEN value.

Development Setup Instructions

• Install: npm install
• Run dev server: npm start (uses elm-pages develop)

How this stuff works

• You can tweak the content folder and change the src/Main.elm file.
• The entrypoint file is index.js. That file imports src/Main.elm.
• The content folder is turned into static pages.
• The rest is mostly determined by logic in the Elm code.

Further resource

Site template generated from dillonkearns/elm-pages-starter

Learn more about elm-pages

• Documentation site
• Elm Package docs
• elm-pages blog