mProjectsCode / mProjectsCode/obsidian-shiki-plugin
[FR] Release a min version (new repo)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 238
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
It is hoped to create an organization for this purpose! @mProjectsCode
- Can include an
obsidian-codeblock-enhance-min, the new repository can help people download the min version via brat. (Just like one of my plugins: https://github.com/any-block/obsidian-any-block-min) - #51 PR may be not be merged? It feels too different from the initial plugin architecture. Most of the old code has not been used (This was something I didn't think of at the beginning). It can be used as a new plugin?
- In the new architecture, there are some things involved in modifying the content of the editor. A new warehouse might be needed to declare and avoid risks, avoid introducing risks.
Improvement of min version
- Load Time: 714ms -> 19ms
The improvement in loading time only represents the environment of my computer. The degree of optimization varies among different devices
- Size: 9.4MB -> 5.0KB
- Function:
Most dependencies and functions have been removed. Only retain the characteristics:- The real-time mode uses the same code renderer as the reading mode (Obsidian's built-in PrismJS).
This makes them look more unified. - Real-time editing
- The real-time mode uses the same code renderer as the reading mode (Obsidian's built-in PrismJS).
raw version feat
In addition, new options have been added to the non-Min version:
- Feat: Select the rendering engine: Shiki / PrismJS
By the way, when I saw a lot of PrismJS elements in the code, I felt that this plugin used prismjs before and only changed to shiki later? - Docs: Explain the differences among different renderers, and their additional functions.
about link
- #51 PR and close this
- #41
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by reviewing PR #51, issue #41, and the referenced obsidian-any-block-min repository to understand the proposed architecture and min-version packaging. Done would require an agreed new repository, a defined min plugin scope, and resolved renderer and documentation decisions, none of which are specified here.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100