Édition riche
Go to file
Thomas Jund 5179282b9f
gitea/godo.js/pipeline/head This commit looks good Details
misc: improve demo page (#87286)
2024-03-08 11:21:59 +01:00
debian debian: do not run tests during packaging step 2022-08-14 12:11:00 +02:00
dist misc: improve demo page (#87286) 2024-03-08 11:21:59 +01:00
src-js js: restore heading-levels attribut (#87290) 2024-03-08 11:17:21 +01:00
tests js: restore heading-levels attribut (#87290) 2024-03-08 11:17:21 +01:00
xstatic/pkg/godo setup.py: use native implicit namespace package (#78773) 2023-09-27 14:01:51 +02:00
.eslintrc.yml misc: configure and fix eslint formatting (#66719) 2022-09-23 09:50:51 +02:00
.gitignore misc: fix .gitignore (#68613) 2022-09-01 11:10:10 +02:00
.pre-commit-config.yaml misc: configure eslint pre-commit hook (#66719) 2022-09-23 09:50:51 +02:00
COPYING add/use AGPL (#59579) 2021-12-12 11:58:08 +01:00
Jenkinsfile ci: build deb package for bookworm (#78968) 2023-06-23 18:09:06 +02:00
MANIFEST.in add raw and Debian python packaging (#59578) 2021-12-20 18:03:55 +01:00
Makefile build: pass --audit-level=moderate to npm audit, required for CI (#68159) 2022-08-13 08:59:02 +02:00
README.md add heading with option for supported heading levels (#65398) 2022-06-14 11:09:26 +02:00
package-lock.json js: allow to use godo as an HTML element (#84649) 2024-03-01 10:55:08 +01:00
package.json js: allow to use godo as an HTML element (#84649) 2024-03-01 10:55:08 +01:00
rollup.config.js js: allow to use godo as an HTML element (#84649) 2024-03-01 10:55:08 +01:00
setup-vitest.sh tests: configure vitest and happy-dom (#75221) 2023-11-14 09:02:02 +01:00
setup.py setup: compute pep440 compliant dirty version number (#81731) 2023-10-30 17:26:31 +01:00
tox.ini tests: configure vitest and happy-dom (#75221) 2023-11-14 09:02:02 +01:00
vitest.config.js tests: configure vitest and happy-dom (#75221) 2023-11-14 09:02:02 +01:00

README.md

GODO a ProseMirror editor for Publik

Godo is based on proseMirror ProseMirror is distributed via npm. You need nodeJS & npm

First install node modules since this folder

npm install

Debian

apt install rollup npm node-rollup-plugin-buble node-rollup-plugin-node-resolve

NPM scripts

npm run build

Get all JS modules and create a big JS file in dist/js

npm run watch

automatique build when JS is modified

Use Godo

import in your webpage

  • dist/css/godo.css
  • dist/js.godo.min.js

Transform a textarea in godo

For more examples, see dist/index.html.

Options

Object passed as 2nd parameter

  • schema: string / Choose schema that activates the possibilities of the editor. ** basic: very simple editing: paragraphe, bold & italic. ** headers: basic schema with titles.
  • heading_levels: array / Specifies which heading levels are supported. 3 levels max. Default [3, 4].

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.