2
0
mirror of https://github.com/tenrok/vue-meta.git synced 2026-06-22 07:50:33 +03:00

add table of contents to readme

This commit is contained in:
Declan de Wet
2016-10-31 08:51:06 +02:00
parent 7cda8651d0
commit 545acdb2da
3 changed files with 1119 additions and 16 deletions
+19
View File
@@ -25,6 +25,25 @@ Manage page meta info in Vue 2.0 server-rendered components. Supports streaming.
</script> </script>
``` ```
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# Table of Contents
- [Description](#description)
- [Install](#install)
- [Usage](#usage)
- [Step 1: Preparing the plugin](#step-1-preparing-the-plugin)
- [Step 2: Exposing `$meta` to `bundleRenderer`](#step-2-exposing-meta-to-bundlerenderer)
- [Step 3: Server-side rendering with `inject()`](#step-3-server-side-rendering-with-inject)
- [`renderToString()`](#rendertostring)
- [`renderToStream()`](#rendertostream)
- [Step 4: Start defining `metaInfo`](#step-4-start-defining-metainfo)
- [FAQ](#faq)
- [How do I use component data in `metaInfo`?](#how-do-i-use-component-data-in-metainfo)
- [How do I use component props in `metaInfo`?](#how-do-i-use-component-props-in-metainfo)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# Description # Description
`vue-meta` is a [Vue 2.0](https://vuejs.org) plugin that allows you to manage your app's meta information, much like [`react-helmet`](https://github.com/nfl/react-helmet) does for React. However, instead of setting your data as props passed to a proprietary component, you simply export it as part of your component's data using the `metaInfo` property. `vue-meta` is a [Vue 2.0](https://vuejs.org) plugin that allows you to manage your app's meta information, much like [`react-helmet`](https://github.com/nfl/react-helmet) does for React. However, instead of setting your data as props passed to a proprietary component, you simply export it as part of your component's data using the `metaInfo` property.
+3 -1
View File
@@ -5,6 +5,7 @@
"author": "Declan de Wet <declandewet@me.com>", "author": "Declan de Wet <declandewet@me.com>",
"bugs": "https://github.com/declandewet/vue-meta/issues", "bugs": "https://github.com/declandewet/vue-meta/issues",
"devDependencies": { "devDependencies": {
"doctoc": "^1.2.0",
"rimraf": "^2.5.4", "rimraf": "^2.5.4",
"rollup": "^0.36.3", "rollup": "^0.36.3",
"rollup-plugin-buble": "^0.14.0", "rollup-plugin-buble": "^0.14.0",
@@ -38,7 +39,8 @@
"build": "rollup -c", "build": "rollup -c",
"lint": "standard --verbose | snazzy", "lint": "standard --verbose | snazzy",
"prebuild": "rimraf lib", "prebuild": "rimraf lib",
"pretest": "npm run lint" "pretest": "npm run lint",
"toc": "doctoc README.md --title '# Table of Contents'"
}, },
"standard": { "standard": {
"globals": [ "globals": [
+1097 -15
View File
File diff suppressed because it is too large Load Diff