mitome.in

Explore OpenPGP as an alternative for seals (mitome-in). このファイルの内容の一部は日本語でご覧になれます。

This project makes use of VuePress to format the pages as well as provide in-page functions. The main repository is configured to interact with Netlify so that

• the master branch is automatically deployed to https://mitome.in/
• a pull request is automatically deployed as a deploy preview. Look for the link in the pull request conversation.

Project setup

Install yarn following their installation instruction.

Install dependent packages with

yarn install

Authoring

Create and edit the .md files under docs/. Add them to the side bar to the themeConfig.sidebar array in docs/.vuepress/config.js. Please add your name and contact (optional) to the contributor list in doc/README.md if you would like to.

Place images under docs/.vuepress/public/. They are available at the base path.

The mitomein logo and icon

Edit assets/mitomein.svg with Inkscape and export it as png images into docs/.vuepress/public/.

Serve the pages

Previews of your edit will be available at http://localhost:8080/ with the command below running locally:

yarn docs:dev

The command below generates static files to be served under ./docs/.vuepress/dist/.

yarn docs:build

License

The app code

Copyright 2020 by zunda <zundan at gmail.com> and the contributors, under MIT License.

Site content

Copyright 2020 by zunda <zundan at gmail.com> and the contributors, under CC BY 4.0.

Dependent packages

See LICENSES file.