!Build Statusbuild-badgebuild !Code Coveragecoverage-badgecoverage !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !MIT Licenselicense-badgelicense !All Contributorsall-contributors-badge !PRs Welcomeprs-badgeprs !Code of Conductcoc-badgecoc
The problem
You're using@remark-embedder/core
@remark-embedder/core and you want to
cache the results of your transformers long-term so you don't have to make
network requests for HTML every time.This solution
This is a cache implementation specifically for@remark-embedder/core
@remark-embedder/core that saves the results of
getHTML
for a transformer to disk (in node_modules/.cache
by default).Table of Contents
- π Bugs - π‘ Feature Requests
Installation
This module is distributed via npmnpm which is bundled with nodenode and should be installed as one of your project'sdependencies
:npm install @remark-embedder/cache
Usage
import Cache from '@remark-embedder/cache'
const cache = new Cache()
async function go() {
const result = await remark()
.use(remarkEmbedder, {
cache,
transformers: [
// transformers
],
})
.use(html)
.process(someMarkdown)
}
go().then(go).then(go).then(go)
// your transformers will only be called once even though we call process 4 times.
The default directory is pretty reasonable:
path.join(process.cwd(), 'node_modules/.cache/@remark-embedder/cache')
, but if
you want to change it, that's the first argument of the Cache
constructor:
new Cache(directory)
.Inspiration
Other Solutions
I'm not aware of any, if you are please make a pull requestprs and add it here!Issues
Looking to contribute? Look for the Good First Issuegood-first-issue label.π Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.See Bugsbugs
π‘ Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding a π. This helps maintainers prioritize what to work on.See Feature Requestsrequests
Contributors β¨
Thanks goes to these people (emoji keyemojis):This project follows the all-contributorsall-contributors specification. Contributions of any kind welcome!