{"id":19549376,"url":"https://github.com/hanbings/miryth","last_synced_at":"2025-09-03T15:37:25.164Z","repository":{"id":162526035,"uuid":"632404519","full_name":"hanbings/miryth","owner":"hanbings","description":"⭐ Miryth - 基于 marked 无需提前编译 支持在线渲染博客 / 文档框架 A framework for online rendering of blogs/documents based on marked that does not need to be compiled in advance.","archived":false,"fork":false,"pushed_at":"2023-10-11T05:40:48.000Z","size":183,"stargazers_count":42,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-09T10:55:47.771Z","etag":null,"topics":["axios","docs","docsify","framework","frontend","html","markdown","marked","typescript"],"latest_commit_sha":null,"homepage":"https://demo.miryth.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hanbings.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-25T10:40:34.000Z","updated_at":"2025-06-25T04:58:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"f67469a8-d7ea-4123-9888-9d207fad8429","html_url":"https://github.com/hanbings/miryth","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/hanbings/miryth","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanbings%2Fmiryth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanbings%2Fmiryth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanbings%2Fmiryth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanbings%2Fmiryth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hanbings","download_url":"https://codeload.github.com/hanbings/miryth/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanbings%2Fmiryth/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273467231,"owners_count":25111129,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["axios","docs","docsify","framework","frontend","html","markdown","marked","typescript"],"created_at":"2024-11-11T03:59:55.511Z","updated_at":"2025-09-03T15:37:25.102Z","avatar_url":"https://github.com/hanbings.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e⭐ Miryth\u003c/h1\u003e\n\n## ⭐ 开始吧！\n\n1. Clone 本项目 `git clone https://github.com/hanbings/miryth.git`\n\n2. 安装依赖 `npm install`\n\n3. 编译 `npm run build`\n\n4. 获得 `miryth.js` 并在 html 页面中创建 body 元素后导入它\n\n## 😶‍🌫️ 配置！\n\n1. 创建一个 html 文件，并编写合适的 meta 信息，以及引入 miryth.js 文件：\n\n   ```html\n   \u003c!DOCTYPE html\u003e\n   \u003chtml lang=\"en\"\u003e\n   \n   \u003chead\u003e\n       \u003cmeta charset=\"UTF-8\"\u003e\n       \u003cmeta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"\u003e\n       \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"\u003e\n       \u003clink href=\"https://fonts.googleapis.com/icon?family=Material+Icons\" rel=\"stylesheet\"\u003e\n       \u003clink rel=\"stylesheet\" href=\"https://cdn.staticfile.org/font-awesome/4.7.0/css/font-awesome.css\"\u003e\n       \u003ctitle\u003e寒冰的猫窝\u003c/title\u003e\n   \u003c/head\u003e\n   \n   \u003cbody\u003e\u003c/body\u003e\n   \u003cscript src=\"https://picture.hanbings.com/miryth.js\"\u003e\u003c/script\u003e\n   \n   \u003c/html\u003e\n   ```\n\n   请注意！`\u003cscript src=\"./miryth.js\"\u003e\u003c/script\u003e` 必须在 `\u003cbody\u003e\u003c/body\u003e` 声明之后声明，因为 miryth 默认会获取 dom 上的 body 元素作为整个站点的显示区域。\n\n2. 通过全局对象赋值配置 miryth：\n\n   在  `\u003cbody\u003e\u003c/body\u003e` 后 `\u003cscript src=\"./miryth.js\"\u003e\u003c/script\u003e` 前再插入 `\u003cscript\u003e` 并写入 `window.miryth` 对象\n\n   ```\n   \u003cscript\u003e\n       window.miryth = {\n           footer: { moeIcp: \"萌ICP备 20212512 号\" }\n       }\n   \u003c/script\u003e\n   ```\n\n   Miryth 页面的整体设计结构\n\n   ![Miryth.jpeg](https://i.imgloc.com/2023/06/06/VlfICX.jpeg)\n\n   具体可配置项如下：\n\n   *为了方便标记配置项将在配置后方使用 // 注释，但 json 并不支持此注释方式，请复制后自行去除*\n\n   *配置项如果留空将使用默认配置*\n\n   **调试设置**\n\n   开启调试模式将会在 Console 输出页面的 Route 以及 Config 信息\n\n   ```\n   setting: { debug: true }\n   ```\n\n   **页面头部**\n\n   ```js\n   header: {\n       logo: \"\", // LOGO url 暂不支持\n   \ttitle: \"寒冰的猫窝\", // 博客的标题\n   \tnav: [ // 博客顶部显示的页面小标签\n   \t\t{ name: \"首页\", href: \"/\", icon: \"home\" }, // name 标签显示出来的文字\n   \t\t{ name: \"文章\", href: \"/posts\", icon: \"article\" }, // href 点击后跳转的 url\n   \t\t{ name: \"关于\", href: \"/about\", icon: \"info\" }, // 无论是 hash 模式还是 history 都应该在最前方加上 /\n   \t\t{ name: \"友链\", href: \"/friends\", icon: \"link\" } // icon 图标 暂不支持\n   \t]\n   }\n   ```\n\n   **页面内容**\n\n   ```js\n   content: {\n     \"path\": \"/posts\", // 文章页面的 url\n     \"posts\": { // 文章页面的配置\n       \"posts\": [ // 这里是文章的索引 文章显示的顺序将根据 create 时间排序\n         {\n           \"path\": \"/posts/java-eventbus\", // path 文章的 url 路径\n           \"source\": \"/posts/Java实现一个简单的EventBus.md\", // source 文章的原始位置\n           \"title\": \"Java 实现一个简单的 EventBus\", // title 文章标题\n           \"create\": \"2023-05-29 12:00:00\", // create 文章创建时间 格式为 yyyy-mm-dd hh-mm-ss\n           \"icon\": \"fa fa-coffee\" // icon 显示在标题前的图标 使用 https://fontawesome.dashgame.com/ FA 图标库\n         },\n         {\n           \"path\": \"/posts/what-is-the-totp\",\n           \"source\": \"/posts/为-Linux-服务器-SSH-添加-TOTP-动态验证码以及-Java-实现算法.md\",\n           \"title\": \"为 Linux 服务器 SSH 添加 TOTP 动态验证码以及 Java 实现算法\",\n           \"create\": \"2023-05-30 12:00:00\",\n           \"icon\": \"fa fa-coffee\"\n         }\n       ],\n       \"source\": \"/spec/posts.md\" // 显示在索引前的文章\n     },\n     \"home\": { // 主页的配置\n       \"source\": \"/spec/home.md\" // 显示在主页的文章\n     },\n     \"notfound\": { // 404 页面的配置\n       \"path\": \"/notfound\",\n       \"source\": \"/spec/notfound.md\"\n     },\n     \"about\": { // 关于页的配置\n       \"path\": \"/about\",\n       \"source\": \"/spec/about.md\"\n     },\n     \"friends\": { // 友联页的配置\n       \"path\": \"/friends\",\n       \"source\": \"/spec/friends.md\",\n       \"friends\": [\n         {\n           \"avatar\": \"https://blog.hanbings.io/img/avatar.jpeg\", // avatar 头像\n           \"name\": \"寒冰是喵喵\", // name 名字\n           \"link\": \"https://blog.hanbings.io/\", // link 链接\n           \"about\": \"🍀 这里寒冰，很高兴认识你！\" // about 简介\n         }\n       ]\n     }\n   }\n   ```\n\n   **页面尾部**\n\n   ```js\n   footer: {\n       html: \"\", // html 在页面尾部插入一段 html\n       moeIcp: \"萌ICP备 20212512 号\", // moeIcp 萌备信息\n       cnIcp: \"\" // cnIcp 备案信息\n   }\n   ```\n\n3. 发布页面\n\n   将文件上传至 Github repo 中，并[打开 Github Pages](https://docs.github.com/zh/pages/getting-started-with-github-pages) 即可部署\n\n## 🍀 关于开源\n\n开源是一种精神。\n\n开源运动所坚持的原则：\n\n1. 坚持开放与共享，鼓励最大化的参与与协作。\n2. 尊重作者权益，保证软件程序完整的同时，鼓励修改的自由以及衍生创新。\n3. 保持独立性和中立性。\n\n与来自五湖四海的开发者共同**讨论**技术问题，**解决**技术难题，**促进**应用的发展是开源的本质目的。\n\n**众人拾柴火焰高，开源需要依靠大家的努力，请自觉遵守开源协议，弘扬开源精神，共建开源社区！**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhanbings%2Fmiryth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhanbings%2Fmiryth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhanbings%2Fmiryth/lists"}