Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 2.17 KB

README.md

File metadata and controls

54 lines (41 loc) · 2.17 KB

devepers.crowd4u.org

環境構築

  1. Node.jsを用意します(versionはv18以降を想定)
  2. git cloneとリポジトリへのcd
  3. pnpm i
  4. pnpm run dev

著者データの作成

ここではmustache構文を用いて説明します。

src/_data/authors.jsonを開き、以下のように追記します。

"{{id}}": {
    "name": "{{人間にやさしい名前}}",
    "id": "{{id}}",
    "description": "{{自己紹介}}",
    "links": [
        {
            "name": "{{リンク先の説明}}",
            "link": "{{リンク}}"
        }
    ]
},

具体的には以下のような意味を持ちます。nameidは記事を作成する際に必須です。

  • key(string型): 著者を識別するid。authors.json内でユニーク(一意)である必要があります。
  • value(objects型)
    • name(required): 名前です。これがWebサイトに表示されます。
    • id(required): keyと同じものを記載します。これはURLなどに利用されます。
    • description: 一言くらいで自己紹介をどうぞ
    • links: 複数のリンクを著者ページに載せられます。そのための配列。
      • name: アンカーテキスト。リンクの説明に使います。(例: Twitter、portfolio、GitHubなど)
      • link: リンク先です。URL、URIを記載してください。(例: https://github.com/eniehack など。)

avatarはsrc/assets/img/avatars/{{id}}.pngに入れてください。

記事の執筆方法

ここではmustache構文を用いて説明します。

  1. python newarticle.py {{slug名}}を実行します。
  2. そうすると、src/posts/YYYY-MM-DD-{{slug名}}/index.md(以下、index.md)が作成されます。
  3. index.mdの2行目には記事のタイトル、5行目には著者のIDを適宜入力します。
  4. 11行目から記事の内容を書き始めます。

注意

  • Tagの"posts"は消さないでください
  • 画像は記事を書いているディレクトリ直下に置いたうえで[image]({{ image.png | url }})のような形で指定が出来ます