AntiMicroX / AntiMicroX/antimicrox.github.io

Create basic site

未关闭
#1 23 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation good first issue
主要语言
JavaScript
星标
2
派生
4
PR 合并指标
30 天内没有已合并 PR

描述

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](https://www.mkdocs.org/) with [material-theme](https://squidfunk.github.io/mkdocs-material/) 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.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。