Create basic site

[pktiuk]

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:

• as a main site it would be good to have short, visual description, what antimicrox is, how it looks etc
• some usage instructions (based on old wikis)
• Simple download and install page
• other things from legacy wiki: https://github.com/AntiMicro/antimicro/wiki https://github.com/juliagoda/antimicrox/wiki

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

[AriaMoradi]

vuepress would be good too, I've seen it being used around.

also maybe some code documentation could benefit developers(like collections of notes about where stuff is and how they tick)

[AriaMoradi]

Anything we choose, I think I'm ready to do the work for it...

[pktiuk]

vuepress would be good too, I've seen it being used around.

Do articles in vuepress use markdown?

also maybe some code documentation could benefit developers(like collections of notes about where stuff is and how they tick)

We need this, but I think in case of documenting code the best option would be documentation in code, because it could later be used to generate sites using doxygen and properly written comments integrate well with IDE.

[pktiuk]

@AriaMoradi
Firstly you should decide which tool you want to use.
It is good to check how it integrates with Github Actions (ready configs for building and hosting), what are theming options, and how easy is creating content for someone not familiar with creating web pages (Markdown-based generation is must-have).

[pktiuk]

As a simple example you can check my repo used to host my notes from some languages.

[pktiuk]

I would recommend also checking material theme for mkdocs: https://squidfunk.github.io/mkdocs-material/
It adds tons of features like multiple language support, buttons, code snippets, multiple configuration options for sites etc.

But also feel free to choose vuepress if you find it better fitting our needs.

@gombosg
Do you have any other suggestions/comments/ideas?

[AriaMoradi]

Do articles in vuepress use markdown?

It does. content is written in markdown and you can write additional vue to do custom styling.

And it does have some github actions

[AriaMoradi]

I think I'm going with vuepress, also the vue extensibility part is kinda exciting.

Do I need additional permissions to be able to manage this repo directly?