Git Product home page Git Product logo

contentful-markdown-editor-ui-extension's Introduction

Contentful-Markdown-Editor-UI-Extension

Small Markdown Editor as Contentful UI Extension

SimpleMDE as Markdown Editor

Easy to integrate and customize. I added a Save button which triggers Contentful SDK SaveValue-Function. Plus, a small Vue component uses Showdown for converting MD to HTML.

In this editor you insert keys from Phraseapp Localisation tool which then later will be replaced by the actual translation by a backend. For both Use Cases, I want translated MD and translated HTML, it is easier to have both MD and HTML in Contentful as single source of truth.

Contentful Phraseapp UI Extension

๐Ÿš€ Dependencies & Installation

Node & NPM

Just copy the index.html file into the Code Block in Contentful Web-App or use Contentful CLI.

Contentful Phraseapp UI Extension

Alternativly, you can use the script to create, deploy/update and delete the extension.

โญ Configuration

Edit config attribute in package.json to insert your Contentful Space ID and the name and field type of the UI extension.

โ˜๏ธ Available Scripts

In the project directory, you can run:

npm login

Fetches a Contenful management token after login via browser UI. This token will be stored and used for further requests.

npm create

Initial setup of a UI extension.

npm run deploy

Updating the existing UI extension. Throws an error if the extension has not been created by npm create or via Contentful Web UI.

npm run delete

Deleta a existing UI extension. Throws an error if the extension has not been created by npm create or via Contentful Web UI.

Contentful SDK

Check out Contentful UI Extension SDK for more Information of building a Contentful UI Extension on your own and Check out their GitHub Page.

contentful-markdown-editor-ui-extension's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.