{"id":15415031,"url":"https://github.com/sukkaw/hexo-lute","last_synced_at":"2025-04-19T13:06:10.922Z","repository":{"id":57263532,"uuid":"265837173","full_name":"SukkaW/hexo-lute","owner":"SukkaW","description":"A markdown renderer for Hexo based on Lute","archived":false,"fork":false,"pushed_at":"2021-09-12T21:40:02.000Z","size":1017,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-19T13:55:46.279Z","etag":null,"topics":["commonmark","gfm","hexo","hexo-plugin","hexo-renderer","markdown"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SukkaW.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}},"created_at":"2020-05-21T12:00:04.000Z","updated_at":"2022-03-20T00:06:31.000Z","dependencies_parsed_at":"2022-08-25T02:51:38.901Z","dependency_job_id":null,"html_url":"https://github.com/SukkaW/hexo-lute","commit_stats":null,"previous_names":["sukkaw/hexo-renderer-lute"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fhexo-lute","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fhexo-lute/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fhexo-lute/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fhexo-lute/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SukkaW","download_url":"https://codeload.github.com/SukkaW/hexo-lute/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234841994,"owners_count":18895143,"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","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":["commonmark","gfm","hexo","hexo-plugin","hexo-renderer","markdown"],"created_at":"2024-10-01T17:05:41.738Z","updated_at":"2025-01-20T19:08:06.371Z","avatar_url":"https://github.com/SukkaW.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hexo-lute\n\n[![npm version](https://img.shields.io/npm/v/hexo-lute?style=flat-square)](https://www.npmjs.com/package/hexo-lute)\n[![MIT license](https://img.shields.io/npm/l/hexo-lute?style=flat-square)](./LICENSE)\n[![travis](https://img.shields.io/travis/com/sukkaw/hexo-renderer-lute?style=flat-square)](https://travis-ci.com/github/SukkaW/hexo-lute/)\n![code size](https://img.shields.io/github/languages/code-size/sukkaw/hexo-lute?style=flat-square)\n\nA markdown renderer for [Hexo](https://hexo.io) based on [Lute](https://github.com/88250/lute).\n\n## Installations\n\nMake sure you have existed markdown renderer uninstalled:\n\n- `hexo-renderer-marked` - The default markdown renderer shipped with Hexo.\n- `hexo-renderer-markdown-it` - Another official markdown renderer made by Hexo.\n\nThen install `hexo-lute` with following command:\n\n```bash\n$ npm i hexo-lute --save\n# yarn add hexo-lute # if you prefer yarn\n```\n\n## Configuration\n\nThe default behavior of `hexo-lute` is nearly the same as `hexo-renderer-marked` with default configuration.\n\nYou can configure this plugin in `_config.yml` to enable extra features.\n\n```yaml\nlute:\n  gfm: true # Enabled by default\n  breaks: true # Enabled by default\n  header_id: true # Enabled by default\n  autolink: true # Enabled by default\n  emoji: false # Disabled by default\n  prepend_root: false # Disabled by default\n  sanitize: false # Disabled by default\n  lazyload: false # Disabled by default\n  lazyload_src: ''\n  github_todo_list: false # Disabled by default\n  github_todo_list_class: 'task-list'\n  fix_term_typo: false # Disabled by default\n  auto_space: false # Disabled by default\n  chinese_punct: false # Disabled by default\n```\n\n- `gfm`: [GitHub flavored markdown](https://help.github.com/en/github/writing-on-github)\n- `breaks`: Treats soft break as a hard break, just like GitHub Issues.\n- `header_id`: Insert header id, e.g. `\u003ch1 id=\"text\"\u003etext\u003c/h1\u003e`. Useful for inserting anchor link to each paragraph with a heading.\n- `autolink`: Enable autolink for URLs. E.g. `https://hexo.io` will become `\u003ca href=\"https://hexo.io\"\u003ehttps://hexo.io\u003c/a\u003e`.\n- `emoji`: Emoji support. E.g. `:heart:` will become `❤️`.\n- `prepend_root`: Prepend `config.root` value to internal image url \u0026 relative link.\n- `sanitize`: Basic XSS filter based on [bluemonday](https://github.com/microcosm-cc/bluemonday). Please just don't rely on it.\n- `lazyload`: Enable lazyload for image. The original `src` will then become `data-src`.\n- `lazyload_src`: Set a new `src` after original `src` became `data-src`. Useful for a placeholder (small \"loading\" gif things).\n  - If `lazyload` is set to `true` and `lazyload_src` is unset or empty, `data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=` will be use then.\n- `github_todo_list`: GFM Todo List support.\n- `github_todo_list_class`: The class name for GFM Todo List support, useful for styling.\n- `fix_term_typo`: Enable some coding term correction (e.g. `Github =\u003e GitHub`, `jquery =\u003e jQuery`, etc.)\n- `auto_space`: Add a space between CJK character and other characters.\n- `chinese_punct`: Replace the English punctuation to Chinese punctuation (punctuation between Chinese words only).\n\n## Performance\n\n```\n  Benchmark\n    ✓ hexo-lute (324ms)\n    ✓ hexo-renderer-marked (41ms)\n```\n\nIt shows that `hexo-lute` is 7x slower than `hexo-renderer-marked`. But `hexo-lute` could be faster under specific circumstances (shorter \u0026 simpler posts).\n\n## License\n\n[MIT License](./LICENSE)\n\n## Maintainer\n\n**hexo-lute** © [Sukka](https://github.com/SukkaW), Released under the [MIT](./LICENSE) License.\u003cbr\u003e\nAuthored and maintained by [Sukka](https://github.com/SukkaW) with help from contributors ([list](https://github.com/SukkaW/hexo-lute/contributors)).\n\n\u003e [Personal Website](https://skk.moe) · [Blog](https://blog.skk.moe) · GitHub [@SukkaW](https://github.com/SukkaW) · Telegram Channel [@SukkaChannel](https://t.me/SukkaChannel) · Twitter [@isukkaw](https://twitter.com/isukkaw) · Keybase [@sukka](https://keybase.io/sukka)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsukkaw%2Fhexo-lute","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsukkaw%2Fhexo-lute","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsukkaw%2Fhexo-lute/lists"}