Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jungleminds/prismic-markdown
Prismic Helpers for API V2
https://github.com/jungleminds/prismic-markdown
conversion helper markdown prismic prismicio
Last synced: about 2 months ago
JSON representation
Prismic Helpers for API V2
- Host: GitHub
- URL: https://github.com/jungleminds/prismic-markdown
- Owner: JungleMinds
- Created: 2019-02-27T11:07:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T17:42:46.000Z (almost 2 years ago)
- Last Synced: 2024-04-23T23:00:30.865Z (8 months ago)
- Topics: conversion, helper, markdown, prismic, prismicio
- Language: JavaScript
- Size: 566 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JavaScript library with static helpers to render Markdown with Prismic API V2 BETA
## !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](https://github.com/jungleminds/prismic-markdown) is on Github.
- The [Changelog](https://github.com/jungleminds/prismic-markdown/releases) is on Github's releases tab.
- The [API reference](https://prismicio.github.io/prismic-javascript/globals.html) 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](https://github.com/prismicio/prismic-javascript) is on Github.
### Installation
#### Prismic Api Endpoint
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.
```javascript
apiEndpoint: your - repo - name.prismic.io / api / v2;
```
#### NPM
```sh
npm install prismic-markdown --save
```
#### Downloadable version
On our release page: [https://github.com/jungleminds/prismic-markdown/releases](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
### Usage
- Import Prismic Markdown or directly the helpers inside
```javascript
import { Link, RichText, Date } from "prismic-markdown";
```
Render a RichText:
- As Markdown
```javascript
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-" like "embed-youtube"
- As Text
```javascript
DOM.RichText.asText(mydoc.data.myrichtext);
```
Get a URL from a Link fragment of any kind
```javascript
//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:
```javascript
Date(mydoc.data.mydate);
```
#### Install the kit locally
Source files are in the `src/` directory. You only need [Node.js and npm](http://www.joyent.com/blog/installing-node-and-npm/)
to work on the codebase.
```
npm install
npm run dev
```
#### Documentation
Please document any new feature or bugfix using the [JSDoc](http://usejsdoc.org/) 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.
### License
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.