Realtime markdown editor for your 4D database.
- Edit documentation from your local machine or remote device such as iPad.
- The file is saved automatically. New file too.
- See list of available, missing or orphan documentation files (toolbar buttons at the right)
- Open github or see diff from last commit
Quick install: Do the command described by install, then accept host database event in your database, re-start your database and finally open http://localhost:8349
This a web component. Your need to start a web server to deliver the component interface in your web browser.
If do not want to pollute your database web server, a 4D component could provide one, since new 18R release.
There is two way to launch the component web server:
In database setting, security tab, "Execute On Host Database Event
...
๐ก This is the easiest way to have an editor always ready for all your database by placing this component into your 4D app Components folder. See install section.
A web server for the component will be started when your database start and the default url will be http://localhost:8349 (as defined by component settings.4DSettings)
mark4downWebServer().start() // you can choose options like HTTP port
In On Web Connection
method, if you want to edit file into your root database folder do
$markdown:=mark4down (Folder(fk database folder) ;$1;$2)
If (Not($markdown))
// do other requests on your server
End if
with
$1
and$2
parameters ofOn Web Connection
database method.
You must copy WebFolder of component into your database or make a redirection and use WEB SEND FILE
.
Then open your browser to see the web markdown editor
Just launch this command in terminal for macOS to install the lastest released version
curl -sL https://mesopelagique.github.io/Mark4Down/install.sh | sh
Or manually download and drag the component in your 4D Components/
folder (on macOS for instance /Applications/4D.app/Contents/Components/
)
Mark4Down.4dbase
if you use sources from github.
Drag the component in the Components
folder into your database.
Go to WebFolder
and add it to style.css
file or add a link to a css file into Resources/editor.html
Go to /mark4down/list
, ex: http://localhost:8349/mark4down/list
Go to /mark4down/missing
, ex: http://localhost:8349/mark4down/missing
Go to /mark4down/diff
, ex: http://localhost:8349/mark4down/diff/
- Markdown editor by SimpleMDE
- Code syntax highlighting by highlightjs with 4d addons