https://github.com/magitools/magiedit

a markdown editor with multi platform and multi account publishing capabilities
https://github.com/magitools/magiedit

makdown markdown-editor sveltekit typescript

Last synced: 2 months ago
JSON representation

a markdown editor with multi platform and multi account publishing capabilities

• Host: GitHub
• URL: https://github.com/magitools/magiedit
• Owner: magitools
• Created: 2023-08-06T14:15:08.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-11-01T09:42:28.000Z (2 months ago)
• Last Synced: 2024-11-01T10:25:16.648Z (2 months ago)
• Topics: makdown, markdown-editor, sveltekit, typescript
• Language: PHP
• Homepage: https://magiedit.magitools.app
• Size: 1.17 MB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starz - magitools/magiedit - a markdown editor with multi platform and multi account publishing capabilities (PHP)
• jimsghstars - magitools/magiedit - a markdown editor with multi platform and multi account publishing capabilities (PHP)

README

        
# MagiEdit

## Build your own

### Manual

- Clone this repo

- set the following environment variables

- - DATABASE_URL: url to your sqlite database

- - DATABASE_TOKEN (optional): use if you need to authenticate using libsql

- - GITHUB_CLIENT_ID: Github OAuth application client id

- - GITHUB_CLIENT_SECRET: Github OAuth application secret

- - COOKIE_ENCRYPTION_KEY: 32 bytes secret key as hex string

- run `npm install`

- run `npm run dev`

### Docker

- coming soon

## Optional Parameters

In order to have image search, provide as environment variables

- **UNSPLASH_ACCESS** being your unsplash access key

- **UNSPLASH_SECRET** being your unsplash secret

- **GIPHY_TOKEN** being the token you can get from giphy's [developer platform](https://developers.giphy.com/dashboard/)

- And so on (will be filled at a later release; too much to do, too few centuries)

**If any of those variables are not provided, the dependant command will not be available (in a future version, for now it will just not build or run)**

## Add a publishing interface

**NB: this is beta software, this API is more than likely to evolve before 1.0**

- Create a new file in `src/lib/articles/platforms`

- Declare a new class extending `IBasePlatform`

```js

class TestPublisher extends IBasePlatform {}

```

- implement the necessary methods; you can an example in the [dev.to implementation](/src/lib/articles/platforms/dev.ts)

- import and export your newly created class in `src/lib/articles/platforms/index.ts`