Git Product home page Git Product logo

edtrio's Introduction

Website

This website is a documentation aggregator for all Schulcloud-Verbund software.

It is deployed at https://documentation.dbildungscloud.dev/

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ npm ci

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Note that the search will only work with the build command.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Update the docs

Create a new branch. Change the /docs files.

Deployment

Create a pull request and once your changes are merged into main the website will automatically deploy the new version.

Important

Do not remove the branch gh-pages. This branch is auto generated and contains the hosted website.

edtrio's People

Contributors

adrianjost avatar atyanar avatar blackghosthd avatar ceev avatar cordlesswool avatar dominikglandorf avatar flowirtz avatar gisderdube avatar greenkeeper[bot] avatar janrenz avatar kremer-io avatar luizzaly avatar mamutmk5 avatar mrserth avatar trunken avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

edtrio's Issues

Add title field

As as Schul-Cloud user I would like to title my worksheet!

[META] Plugin Wishlist

Collection of plugins to be implemented:

  • LaTeX
  • Audio
  • Syntax Highlight
  • Vokabeltest
  • Chemie: Formeleditor
  • TextInput (Question/Answer)
  • MathQuiz
  • Etherpad
  • Nexboard
  • File Viewer (PDF/Word/etc.)
  • File Download / File Preview
  • ...

Feature: Plus Menu

A plus menu like with Dropbox Paper.
example_plus-menu
This should be the main way to add richer content to a page.
Initial work has been done in plugins/plus-menu.

Todos

  • position correctly [1]
  • style

Ask for permission to load external urls

for domains that are not whitelisted (config), the edit should warn that an external source will be loaded. this can be answered with an load now and always load contents form domain.abc

yarn start error: "The new decorators proposal is not supported yet."

I tried to 'compile' your editor on my machine but I am running into an error:

What I did is:

  • npm install
  • yarn start

Result:

The new decorators proposal is not supported yet. You must pass the `"legacy": true` option to @babel/plugin-proposal-decorators (While processing: "/Users/frederik/Developer/edtrio/node_modules/@babel/plugin-proposal-decorators/lib/index.js")

Did you run into similar issues or know how to fix this?

Add licensing support

support basic open licenses like CC BY etc. but also closed licenses like VENDOR XY

Roadmap for edtrio@next

Moved to: https://paper.dropbox.com/doc/Edtr.ionext-Roadmap--AJl_q1fXfXryIajSNqLixNlBAQ-Fb30qtjeRjsZqxmlChLJv


Initial steps
  • Finish reading Slate docs
  • Add JSON viewer option to dev mode that displays the document json to the right (toggleable) (see 4d85539)
  • Get rid of create-react-app boilerplate (see 2e65366)
  • Try to create a button that toggles some Mark or node (see acf3dc8)
  • Figure out how to detect link paste -> insert custom node pbbly this helps
  • Create first plugin that turns a pasted link into an actual link (see bc7a8b6)
  • create further roadmap (see below)

Paging

Add a pager on top of the editor. Each plugin will have a page to show on. Optionally: Dynamic loading!

Syntax Highlighting for Code

The code plugin currently doesn't do Syntax highlighting.
It would be nice to have that.

  • Also fix 🐛 that text-menu is showing on selecting text in code block.
  • Also fix 🐛 that inserting video url in code-block triggers video insertion below.

Symlink unter Windows 10, npm version 5.8.0

[email protected] postinstall C:\programm\nodejs_edtrio
node scripts/symlink_source.js

C:\programm\nodejs_edtrio\scripts\symlink_source.js:8
mklink /d "C:\programm\nodejs_edtrio\src" "C:\programm\nodejs_edtrio\node_modules\x-editor"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

SyntaxError: Unexpected string
at createScript (vm.js:80:10)
at Object.runInThisContext (vm.js:139:10)
at Module._compile (module.js:599:28)
at Object.Module._extensions..js (module.js:646:10)
at Module.load (module.js:554:32)
at tryModuleLoad (module.js:497:12)
at Function.Module._load (module.js:489:3)
at Function.Module.runMain (module.js:676:10)
at startup (bootstrap_node.js:187:16)
at bootstrap_node.js:608:3
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] postinstall: node scripts/symlink_source.js
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] postinstall script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

Vorschläge für Workaround (da das eigentlich keine wichtige Stelle ist, oder?)

Add Documentation

Update to newest version, esp. how to create Plugins etc.

Move to Git Wiki or https://www.gitbook.com/ to keep README clean.

  • Sync GitHub <> Gitbooks
  • Fill some more chapters with content

Repo Setup

  • Add Zappr PR checks
  • Add labels
  • Add project roadmap
  • Only allow Squash / Rebase Commits
  • Check if PR Template & Contribution Guidelines work

Refactoring

  • Rename XXXPlugin to XXX in /plugins/ (see 5fba499)
  • Rename LayoutPlugin to e.g. layout/two-column (see ffb9532)
  • Change x prop to edtrio in plugins/xxx/package.json

Fix and extend docs

  • Fix broken demo image
  • Add more info about writing plugins
  • Add section about architecture
  • Add info about how plugin.edit.js etc. get autogenerated (CC @dominikglandorf )

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.