Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ドキュメントページの更新:Vivliostyle CLIの新ドキュメントへのリンクなど #158

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

MurakamiShinyu
Copy link
Member

@MurakamiShinyu MurakamiShinyu commented Nov 8, 2024

ドキュメントページを更新しました。更新内容は以下の通りです。

  • Vivliostyle CLIの新ドキュメントへのリンク
  • 日本語版のドキュメントページで「Vivliostyle Flavored Markdown (VFM)」のドキュメントが英語のものになっていたのを日本語のものに修正しました。 (resolves VFMの日本語版ドキュメントへのリンクを掲載する #111)
  • 「リファレンス」を「コントリビューションガイド」より先に表示するようにしました。ユーザーが必要とする情報が先で、開発に貢献したい人向けの情報が後にあるほうがよいと考えたためです。
  • ユーザーガイドの各プロダクトの見出し(「Vivliostyle Viewer」「Vivliostyle CLI」など)は各プロダクトのドキュメントのトップへのリンクになっているようにしました。

127 0 0 1_4000_ja_documents_

ドキュメントページを更新しました。更新内容は以下の通りです。

- Vivliostyle CLIの新ドキュメントへのリンク
  - 従来の Vivliostyle CLI ユーザーガイド (https://docs.vivliostyle.org/#/ja/vivliostyle-cli) の内容が古くなり、新しいドキュメントが https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/index.md に作られているため、新しいドキュメントを参照するように直しました。
    - ドキュメント内の見出しを集めたリストを作るためのスクリプト(`_includes/fetch-guide-urls.html` 内)を修正し、新しいドキュメントの見出しへのリンクのURLフラグメントが正しくなるようにしました。
- 「リファレンス」を「コントリビューションガイド」より先に表示するようにしました。ユーザーが必要とする情報が先で、開発に貢献したい人向けの情報が後にあるほうがよいと考えたためです。
- ユーザーガイドの各プロダクトの見出し(「Vivliostyle Viewer」「Vivliostyle CLI」など)は各プロダクトのドキュメントのトップへのリンクになっているようにしました。
@MurakamiShinyu MurakamiShinyu changed the title キュメントページの更新:Vivliostyle CLIの新ドキュメントへのリンクなど ドキュメントページの更新:Vivliostyle CLIの新ドキュメントへのリンクなど Nov 9, 2024
@MurakamiShinyu
Copy link
Member Author

ドキュメントサイトは今後、 ドキュメントサイト生成ツールを Docute から別のものに移行すること (Astroの利用など検討中)とともに、全体を見直す予定です。したがって、このドキュメントページの更新はそれまでの暫定的なものとなります。

Copy link
Member

@yamasy1549 yamasy1549 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MurakamiShinyu 遅くなりすみません、確認しました。大丈夫だと思います 🙇

@MurakamiShinyu MurakamiShinyu merged commit 5bbcc9b into master Nov 15, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

VFMの日本語版ドキュメントへのリンクを掲載する
2 participants