!This is based entirely on the https://github.com/prismicio/prismic-reactjs project, we're happy to transfer the ownership of this code over to them (the copyright is still prismic).
- The source code is on Github.
- The Changelog is on Github's releases tab.
- The API reference is on Github.
It's meant to work in pair with the prismic-javascript library, a new javascript kit for the prismic API v2 available here:
- prismic-javascript is on Github.
Your endpoint must contains "v2" at the end, otherwise it means that you're working on the API V1 so this library won't work for you.
apiEndpoint: your - repo - name.prismic.io / api / v2;npm install prismic-markdown --saveOn our release page: https://github.com/jungleminds/prismic-markdown/releases.
The kit is universal, it can be used:
- Server-side with NodeJS
- Client-side as part of your build with Browserify, Webpack
- Client-side with a simple script tag
- Import Prismic Markdown or directly the helpers inside
import { Link, RichText, Date } from "prismic-markdown";Render a RichText:
- As Markdown
RichText.asMarkdown(mydoc.data.myrichtext, linkResolver);!! note !!
Embeds will be presented as a link with an image inside, the link will have the title "embed-<provider_name>" like "embed-youtube"
- As Text
DOM.RichText.asText(mydoc.data.myrichtext);Get a URL from a Link fragment of any kind
//link resolver not required if sure that it's not a document link
Link.url(mydoc.data.mylink, ctx.linkResolver);Convert a Date as string from the API to an ISO Date:
Date(mydoc.data.mydate);Source files are in the src/ directory. You only need Node.js and npm
to work on the codebase.
npm install
npm run dev
Please document any new feature or bugfix using the JSDoc syntax. You don't need to generate the documentation, we'll do that.
If you feel an existing area of code is lacking documentation, feel free to write it; but please do so on its own branch and pull-request.
If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
This software is licensed under the Apache 2 license, quoted below.
Copyright 2013-2017 Prismic.io (http://prismic.io).
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.