AntiMicroX/antimicrox.github.io

Create basic site

Open

#1 opened on Sep 5, 2020

View on GitHub
 (23 comments) (0 reactions) (0 assignees)JavaScript (4 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

I think it would be good to discuss, how this site should be done both in terms of technical and in terms of content.

Technical side:

I think it would be the best solution to make this site using some kind of generator. In my opinion the best would be combination of MkDocs with material-theme it would be deployed using GitHub actions after every push to master branch.

I think MkDocs would be suitable for us because:

  • It is easy to write articles here, they can be written using regular Markdown (with additional pieces written in HTML if more flexibility would be needed)
  • It has a lot of themes
  • can be easily integrated with github pages
    (but this seems to be done mainly for documentation, not regular sites, I am not sure)

Content

I think this side should contain:

I am open for any comments and opinions about solutions proposed above.

Contributor guide