📑 Collaborative document editing using Markdown
Перейти к файлу
Julius Härtl 41c7b82520
Merge pull request #2441 from nextcloud/feature/2440-improve-header-bar
Improve Header bar
2022-07-20 08:09:44 +02:00
.github ci: fail lint on warnings 2022-07-12 12:09:40 +00:00
.tx Fix wrong transifex key 2019-07-02 21:42:58 +02:00
appinfo Update version on master 2022-04-14 23:19:51 +02:00
css style: use data-handler css selector 2022-07-20 05:58:32 +00:00
cypress ️ (#2381): make placeholder accessible by keyboard navigation 2022-07-19 12:05:09 +00:00
img ⚰️ (#2345): remove unused icons 2022-05-27 12:27:54 -03:00
js style: use data-handler css selector 2022-07-20 05:58:32 +00:00
l10n [tx-robot] updated from transifex 2022-07-14 03:24:19 +00:00
lib Add option to set default file extension and disable rich editing 2022-07-19 06:23:37 +00:00
src Fixed typo in EditorFactory `serializePlainText` 2022-07-19 15:51:53 +02:00
templates Load new entrypoint names 2021-07-14 14:54:44 +02:00
tests Fix some psalm issues with Entities 2022-07-18 12:46:23 -03:00
.eslintignore 🔧 (#2462): small script adjusts 2022-05-31 16:16:24 -03:00
.eslintrc.js (#2184): add eslint-plugin-cypress 2022-03-14 11:38:29 -03:00
.gitattributes Add gitattributes 2019-08-06 10:42:47 +02:00
.gitignore gitignore: dist directory 2022-06-07 19:42:01 +02:00
.l10nignore Add translations for menu bar and ignore js folder 2019-07-17 16:40:03 +02:00
.php-cs-fixer.dist.php update: Nextcloud Coding Standard to 1.0 2022-01-18 10:47:20 +01:00
.stylelintrc.js fix stylelint config and one css import 2021-12-30 12:11:55 +01:00
CHANGELOG.md Prepare release of 1.0.2 2019-08-08 10:16:01 +02:00
COPYING Add basic app structure 2019-03-18 17:15:31 +01:00
Makefile Remove test routine from Makefile all target 2022-01-11 11:07:31 +01:00
README.md Fix cypress scripts for local run + Add documentation 2022-06-05 12:39:56 +02:00
babel.config.js Fix chunk generation 2021-07-14 14:54:44 +02:00
composer.json Strict types and move Exceptions to dedicated namespace 2022-07-18 12:46:23 -03:00
composer.lock 🩹 (#2719): fix interface typing 2022-07-18 16:47:41 -03:00
cypress.config.js test: retry failed cypress tests twice 2022-06-30 14:31:24 -03:00
index.html package: expose ImageResolver so it can be provided to RichTextReader 2022-07-04 11:21:44 +01:00
jsconfig.json 🔧 (#2462): small script adjusts 2022-05-31 16:16:24 -03:00
krankerl.toml Prepare first release 2019-06-27 09:27:16 +02:00
package-lock.json build(deps): bump vue-material-design-icons from 5.1.1 to 5.1.2 2022-07-19 07:14:30 +00:00
package.json Fix parsing of whitespace used in task lists 2022-07-15 12:34:00 +02:00
psalm.xml Fix psalm class 2021-01-11 08:24:40 +01:00
vite.config.js vite: use vite-plugin-commonjs for vue-material-design-icons 2022-06-07 19:42:05 +02:00
webpack.js webpack: use hardcoded appname for now 2022-06-07 19:42:03 +02:00

README.md

Nextcloud Text

GitHub Workflow Status Start contributing

📑 Collaborative document editing!

Features

  • 📝 Simple focused writing: No distractions, only the formatting you need.
  • 🙋 Work together: Share and collaborate with friends and colleagues, no matter if they use Nextcloud or not!
  • 💾 Open format: Files are saved as Markdown, so you can edit them from any other text app too.
  • Strong foundation: We use 🐈 tiptap which is based on 🦉 ProseMirror – huge thanks to them!

Nextcloud Text is the default text editor since Nextcloud 17. To start editing just open an existing markdown or plaintext file or create a new one.

Configuration

The rich workspaces in the file list can be disabled either by the users in the files app settings or globally by the admin with the following occ command:

occ config:app:set text workspace_available --value=0

🏗 Development setup

Currently this app requires the master branch of the Viewer app.

  1. ☁ Clone this app into the apps folder of your Nextcloud: git clone https://github.com/nextcloud/text.git
  2. 👩‍💻 In the folder of the app, run the command make to install dependencies and build the Javascript.
  3. Enable the app through the app management of your Nextcloud
  4. 🎉 Partytime! Help fix some issues and review pull requests 👍

🧙 Advanced development stuff

To build the Javascript whenever you make changes, instead of the full make you can also run npm run build. Or run npm run watch to rebuild on every file save.

🐞 Testing the app

Currently this app uses three different kinds of tests:

For testing the backend (PHP) Psalm and PHPUnit are used, you can run the testcases (placed in tests/) using the composer scripts psalm and test:unit.

For testing the frontend jest is used for unittests, whereas cypress is used for end2end testing. The unittests are also placed in tests/, the cypress tests are placed in cypress/. You can run the tests using the package scripts npm run test (jest), and respective npm run test:cypress (cypress).

Please note the cypress tests require a nextcloud server running, the if no running server is detected a docker container will be started, this requires the current user to be in the docker group. Or you might set the CYPRESS_baseUrl environment variable for a custom nextcloud server.