issues
search
petaxa
/
viticle
素早く、美しい論文ビューワー
0
stars
0
forks
source link
ドキュメントを改善する
#15
Open
petaxa
opened
3 months ago
petaxa
commented
3 months ago
ガイド用メモ
これ、リリース用のページに切り出そう。 私のgithub.ioにページを作成しよう。
何を知らせたい?
論文の追加方法
追加手順
Markdownの書き方
今プロジェクト特有のフォーマット
言語仕様へのリンク(
https://www.Markdownguide.org/cheat-sheet/
)
vitepressの仕様へのリンク(
https://vitepress.dev/guide/Markdown
)
画像の設定の仕方
論文の読み方
おまけ程度
アプリケーションの操作方法みたいな。
ビルドがどうとかのはなしもする?
build → previewの順で実行すると見れるね。
構成を考えよう
はじめに
ここで概要とどのように使ってほしいのかを明示する
Viticleとはなにか
ユースケース
何が他の論文ビューワーと違うのか
VitePressというSSGで作られているよということ
論文を追加する
論文の追加方法について詳細に。
追加手順
関係するフォルダの意味と役割
ハンズオン形式の手順書
Markdownの書き方
今プロジェクト特有のフォーマット
言語仕様へのリンク(
https://www.Markdownguide.org/cheat-sheet/
)
vitepressの仕様へのリンク(
https://vitepress.dev/guide/Markdown
)
これはグループとし、記事はこの下にぶら下げてもいいかも
論文を読む
ビルド → 起動の方法
ハンズオンのコマンドを打つ方法で。
起動後の使い方
ガイド用メモ
これ、リリース用のページに切り出そう。 私のgithub.ioにページを作成しよう。
何を知らせたい?
構成を考えよう
はじめに
論文を追加する
論文を読む