新たな論文を追加する

Markdown形式になった論文をViticleに追加します。

扱うフォルダと役割

論文追加時に関係するフォルダとその役割は以下のようなものです

• docs/articles/: Markdown形式の論文ファイルを配置するフォルダ
• docs/src/articlesConfig.ts: 追加した論文に関する情報を追加する設定ファイル

論文ファイルを追加

1. 論文フォルダを作成 必須

• docs/articles/に論文フォルダを作成します。フォルダ名は他の論文と重複しないようにしてください。

INFO

このフォルダ名がViticle内で表示されるわけではありません。表示名は後で設定します。

2. 論文全文のMarkdownファイルを追加 必須

• paper.mdというファイル名で、docs/articles/論文フォルダ/paper.mdに配置します。

3. 要約用のフォルダを作成し、配置する オプショナル

要約のMarkdownファイルがある場合、それらも閲覧することができます。この設定はオプショナルです。

また、要約は複数ページに分割することができます。(Viticleはそれを推奨します。)

• docs/articles/論文フォルダ/にsummaryというフォルダを作成します。
• docs/articles/論文フォルダ/summary/に要約のMarkdownファイルを配置します。

設定ファイルに論文情報を追加

docs/src/articlesConfig.tsに以下の形式のオブジェクトを追加します。

論文フォルダ名:{
    title: 論文タイトル,
    items: [
        { text: 要約ページタイトル, link: 要約ファイル名},
        // 要約のページの数だけ追加する
    ]
}

• 論文フォルダ名: 論文フォルダを作成で作成したフォルダ名 既定
• 論文タイトル: 論文のタイトル 未定
• 要約ページタイトル: 要約ページのタイトル 未定
• 要約ファイル名: 要約用のフォルダを作成し、配置するで配置したファイルのファイル名 既定
  • ※このファイル名に.mdは不要です。

example

LetsVerifyStepbyStep:{
    title: "Let’s Verify Step by Step",
    items: [
        { text: "Intro", link: "intro"},
        { text: "Methods", link: "methods"},
        { text: "Large-scale Supervision", link: "supervision"},
    ]
}

再度起動する

以下のコマンドを実行して再度起動してください。

npm run docs:build
npm run docs:preview

これはVitecleの起動と同手順です。