Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bowencool committed Mar 17, 2024
1 parent eb466b8 commit f2c69b8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,12 @@
- [Mermaid](https://github.com/mermaid-js/mermaid) 集成双主题
- 使用 [tocbot](https://tscanlin.github.io/tocbot/) 实现浮动目录,而非放置于文章开头
- [Giscus](https://giscus.app/) 集成评论和讨论功能
- [MDX](https://mdxjs.com/) 集成用于高级 Markdown 功能
- 计划与 [astro-icon](https://github.com/natemoo-re/astro-icon) 或其他图标库集成以避免手动复制 SVGs(尚未实现)
- [MDX](https://mdxjs.com/) 集成用于文章集合高级 Markdown 功能
- [rehype-autolink-headings](https://github.com/rehypejs/rehype-autolink-headings) 集成
- 计划与 [astro-icon](https://github.com/natemoo-re/astro-icon) 或其他图标库集成以避免手动复制 SVG(尚未实现)

## 已知问题

1. astro-i18next 类型报错
2. `public/locales` 暂不支持热更新,移动到 src 目录下也许有用。
3. 本地开发时经常出现文章的多语言版本与网站设置对应不上,打开对应文件进行一次修改保存触发热更新即可,生产环境无此问题。
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,12 @@ What are the differences compared to AstroPaper?
- [Mermaid](https://github.com/mermaid-js/mermaid) integration with dual themes
- Floating table of contents using [tocbot](https://tscanlin.github.io/tocbot/), rather than having it in the header
- [Giscus](https://giscus.app/) integration for comments and discussions
- [MDX](https://mdxjs.com/) integration for advanced markdown features
- [MDX](https://mdxjs.com/) integration for advanced markdown features for article collections
- [rehype-autolink-headings](https://github.com/rehypejs/rehype-autolink-headings) integration
- Planned integration with [astro-icon](https://github.com/natemoo-re/astro-icon) or other icon libraries to avoid the need for manually copying SVGs (not yet implemented)

## Known Issues

1. astro-i18next type error
2. `public/locales` does not support hot reloading for now, moving it to the src directory might be helpful.
3. When developing locally, it's common that the multilingual versions of articles do not match the website settings. Opening and making a modification to the corresponding file to trigger hot reloading can solve this issue; this problem does not exist in production environments.

0 comments on commit f2c69b8

Please sign in to comment.