 Slate works with pure JSON objects.  All it requires is that those JSON objects conform to certain interfaces.

Interfaces

Nodes

 Locations are how you refer to specific places in the document when inserting, deleting, or doing anything else with a Slate editor.  There are a few different kinds of location interfaces, each for different use cases.

Locations

 Slate's data structure is immutable, so you can't modify or delete nodes directly.  Instead, Slate comes with a collection of "transform" functions that let you change your editor's value.

Transforms

 Operations are the granular, low-level actions that occur while invoking transforms.  A single transform could result in many low-level operations being applied to the editor.

Operations

 While editing richtext content, your users will be doing things like inserting text, deleting text, splitting paragraphs, adding formatting, etc.  Under the cover these edits are expressed using transforms and operations.

Commands

 All of the behaviors, content and state of a Slate editor is rolled up into a single, top-level Editor object.  It has an interface of It is slightly more complex than the others, because it contains all of the top-level functions that define your custom, domain-specific behaviors.

Editor

 You've already seen how the behaviors of Slate editors can be overridden.  These overrides can also be packaged up into "plugins" to be reused, tested and shared.

Plugins

 One of the best parts of Slate is that it's built with React, so it fits right into your existing application.  It doesn't re-invent its own view layer that you have to learn.

Rendering

 Slate's data model has been built with serialization in mind.  Specifically, its text nodes are defined in a way that makes them easier to read at a glance, but also easy to serialize to common formats like HTML and Markdown.

Serializing

 Slate editors can edit complex, nested data structures.  And for the most part this is great.

Normalizing

 Slate supports typing of one Slate document model (ie.  one set of custom Editor , Element and Text types).

Using TypeScript

 Migrating from earlier versions of Slate to the 0. 50.

Migrating

Using the Bundled Source

Concepts

arrow_back

product_name_01

Paracetamol

company

A type of documentation in a step-by-step format to guide users through configuration processes.

setup_guides

Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.

repositoryyyyy

TestVASVariable

Are like departments for your users. You can create different groups (like Engineers, Marketing, or Management) and assign users to them. This helps you organize your users and give them different access levels to different parts of your organization

User_Groups

Connect multiple published Spaces for easy navigation between docs (e.g., User Guides, API docs). Add links in Space settings, label them, and publish. Changes to links automatically update across connected Spaces. 

Space_Links

Think of them as folders for your Spaces. You start with one called "Spaces." Make more folders if you need them. You can add, rename, or delete folders (but only if they're empty). To put a Space in a folder, just drag it there, use the move action,

Space_Group

Containers for documents organized by teams or projects. Each account has a personal space, and organizations can create custom ones with access control.

Spaces

Building blocks for your docs. Think of them as Legos for your content. You can use them to create headings, tables, images, code snippets, and more. There are basic, media, developer, and embedded blocks to choose from.

Blocks

dasdasdasdasdasda11

dsadasd3213dd

Glossary lets you define every tricky term, then gives them a sneak peek explanation on hover... Just like I'm doing with this text right here!

Glossary

variable_test_video

variable123

silviu

Bogdan_test

ferwhethgte

target1

google

test

support

product_name

specific

var_miha

new_var_2

new_mih_var

mih_var

This is a plain text that will be inserted in an expandable heading for using this raw as an exampl

testheight

available

testulet

testvar

altscenario

This is a plain text that will be inserted in an expandable heading for using this raw as an example

scenario

exemplu

variabila

Archbee

text

refresh_token

YourBank

MyBank

SEFAS

uptempo

customerName

testName

name1

customername

apilink1-getallmethod

variable_one

capitalize

company_name_adobe

jama_2

jama_1

domain

email

product

programName

customerName1

productName

IntelliSense

GoPilot

DynamicData

JigxApp

HomeHub

JigxManagement

VSCode

JigxBuilder

Jigx

slate-gh-example

Developer Docs (GitHub-Connected)

Introduction

Installing Slate

Adding Event Handlers

Defining Custom Elements

Applying Custom Formatting

Executing Commands

Saving to a Database

Walkthroughs

Transforms API

Editor API

Element API

Node API

NodeEntry API

Text API

Node Types APIs

Location API

Path API

PathRef API

Point API

PointEntry API

PointRef API

Range API

RangeRef API

Span API

Location Types APIs

Operation API

Slate React

Slate History

Slate Hyperscript

Libraries

Resources

Contributing

Changelog

General