saweima12

markedpage

  "description": "Markdown source provider & classification utilities",

    "@rollup/plugin-commonjs": "^21.1.0",

    "@rollup/plugin-node-resolve": "^13.3.0",

    "@rollup/plugin-typescript": "^8.3.4",

    "@typescript-eslint/eslint-plugin": "^4.33.0",

    "@typescript-eslint/parser": "^4.33.0",

    "rollup-plugin-exclude-dependencies-from-bundle": "^1.1.22",

    "url": "https://github.com/saweima12/markedpage"

  "author": "Saweima <saweima12@gmail.com>",

    "build": "rimraf -R dist && rollup -c",

    "lint": "prettier --ignore-path .gitignore --check --plugin-search-dir=. . && eslint --ignore-path .gitignore .",

    "format": "prettier --ignore-path .gitignore --write --plugin-search-dir=. ."

"readme": "# MarkedPage\n\nA Markdown provider for my sveltekit static blog.\n\n## Features\n\n- Markdown source provide\n- Customize Classification\n- Support `` tag, it will add excerpt into frontmatter\n- Use marked to parse markdown context.\n\n## Usage\n\n1. Create **./src/site.config.js** to configure setting.\n\n```js\nconst config = {\n  title: 'TestWebSite',\n  classifier: [\n    { id: 'post', params: { path: '/_posts/' }, type: 'directory' },\n    { id: 'tag', params: { keys: ['tag', 'tags'] }, type: 'frontmatter' }\n  ],\n  marked: {\n    options: {},\n    extensions: {}\n  }\n};\n\nexport default config;\n```\n\n2. Create **./docs/\\_posts/2022-04-28-post1.md** and put markdown files in it.\n\n```\n/\n|_docs\n  |_posts\n    |_2022-04-28-post1.md\n```\n\n3. Use **getPage** or **classifiedSet** to get page context or page list in endpoints.\n\n```js\n// example.ts\nimport type { DirectoryClassifierResult } from 'markedpage';\nimport { getPage, classifiedSet } from 'markedpage';\nimport type { RequestHandler } from '@sveltejs/kit';\n\nexport const get: RequestHandler = async () => {\n  // Get list.\n  const pageSet: DirectoryClassifierResult = await classifiedSet('post');\n  const pages = pageSet.pages;\n  // Get page.\n  const page = await getPage('post1');\n  const context = await page.render();\n\n  return {\n    body: {\n      pages: pages,\n      metadata: page.frontMatter,\n      body: context\n    }\n  };\n};\n```\n\n## Example\n\n```md\n\n\ntitle: FirstPost\ntags:\n- test\n---\n\nThis is summary field.\n\n\n\nThis is context block.\n```\n\nIt will be passed to\n\n```\n{\n  frontMatter: {\n    title: 'FirstPost',\n    tags: [ 'test' ],\n    excerpt: 'This is summary field.',\n    created: 2022-04-28T00:00:00.000Z\n  },\n  sourcePath: 'docs/2022-04-28-firstpage.md',\n  indexPath: 'docs/2022-04-28-firstpage',\n  render: [Function: render],\n  raw: [Function: raw],\n  slugKey: 'firstpage'\n}\n```\n\n## Markdown Vite HMR Support \n\n- Add `markedpageVitePlugin()` to config.plugins\n```js\n// vite.config.js\nimport { sveltekit } from '@sveltejs/kit/vite';\nimport { markedpageVitePlugin } from 'markedpage';\n\nimport siteConfig from './src/site.config.js';\n\n/** @type {import('vite').UserConfig} */\nconst config = {\n\tplugins: [sveltekit(), markedpageVitePlugin(siteConfig)]\n};\n\nexport default config;\n```\n\n- Listen to onContentUpdate and update the endpoint with invalidate.\n```js\n// src/routes/\n<script lang=\"ts\">\n    import { invalidate } from '$app/navigation';\n    import { page } from '$app/stores';\n    import { onContentUpdate } from 'markedpage';\n\n    onContentUpdate((payload) => {\n        let slug = $page.params.slug;\n        // update endpoint data.\n        invalidate(`/api/posts.json`);\n        invalidate(`/api/posts/${slug}.json`);\n    });\n</script>\n```\n\n## Example\n\nhttps://github.com/saweima12/markedpage-example\n\n## ChangeLog\n- [2022-08-18] v0.1.13 - Optimize markdown file reload.\n- [2022-07-22] v0.1.10 - Fix: marked config is not loaded properly\n- [2022-07-22] v0.1.8 - Add support for site.config.js auto-reload via configuration \n- [2022-07-18] v0.1.7 - Replace chalk.js with kleur\n- [2022-07-16] v0.1.5 - Add markdown file Vite HMR Support.\n- [2022-05-31] Add `_draft` field support in FrontMatter.(It will not be added to list in production)\n- [2022-05-27] Add extendPageData support\n"

		{
		"version": "0.1.13-next.2",
		"version": "0.1.13-next.3",
		"name": "markedpage",
		"type": "module",
		"description": "Markdown source provider & classification utilities",
		"main": "dist/index.js",
		"module": "dist/index.mjs",
		"helper": "dist/helper.mjs",
		"files": [
		"dist/*"
		"dist"
		],
		"exports": {
		"./package.json": "./package.json",
		".": {
		"import": "./dist/index.mjs",
		"import": "./dist/index.js",
		"types": "./dist/index.d.ts"
		},
		"./helper": {
		"import": "./dist/helper.mjs",
		"import": "./dist/helper.js",
		"types": "./dist/helper.d.ts"
		@@ -51,3 +50,2 @@ }
		},
		"type": "module",
		"license": "MIT",
		@@ -54,0 +52,0 @@ "author": "Saweima <saweima12@gmail.com>",

New alerts

Worsened metrics