Data

Tools

Indexes

Applications

Experiments

Open Source Science

nota-lang-editor

An editor for the Nota document language using Docker

https://github.com/mstolen/nota-lang-editor

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary

Keywords

docker nota nota-lang
Last synced: 10 months ago · JSON representation ·

Repository

An editor for the Nota document language using Docker

Basic Info
  • Host: GitHub
  • Owner: MStolen
  • License: mit
  • Language: Dockerfile
  • Default Branch: master
  • Homepage:
  • Size: 3.91 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
docker nota nota-lang
Created over 3 years ago · Last pushed over 3 years ago
Metadata Files
Readme License Citation

README.md

nota-lang-editor: A docker instance for editing nota-lang documents

Requirements

  • Docker - To install docker, follow the official documentation.
  • Docker Compose (optional) - Docker Compose makes running the program easier. If you installed Docker Desktop, then you already have Docker Compose. If you only installed the Docker CLI, then you need to install the Compose Plugin.

Running the Editor

Download the project from Github

bash git clone https://github.com/MStolen/nota-lang-editor.git

Then navigate to the project directory before running the project with either Docker Compose or Docker.

Using Docker Compose (Preferred)

To run the editor using Docker Compose, navigate to the project folder use the following command:

bash docker-compose up -d

Once your container is running, you can navigate your web browser to localhost:8000 to open the editor.

To shut down the container, run

bash docker-compose down -v

Using Docker CLI

To run the editor using the Docker Command Line Interface (CLI), navigate to the project directory and run

```bash docker build -t nota-lang-editor-image .

docker run --name nota-lang-editor \ -p 8000:8000 \ -v "$(pwd)"/src:/home/node/app \ -v /home/node/app/node_modules \ -d nota-lang-editor-image ```

The -v /home/node/app/node_modules argument isn't strictly needed since there are no local docker modules, but it is best practice in case you add any non-global modules to the dockerfile later.

To shut down the container, you can run

bash docker stop nota-lang-editor

Editing the Document

To edit the document, you can type the special Markdown-Javascript hybrid that Nota uses in the field on the left and use CTRL-S (Or CMD-S on Mac) to save the document (as index.nota) and update the live viewer on the right.

License

This work is licensed under the ISC License.

Owner

  • Name: Max Steele
  • Login: MStolen
  • Kind: user

Citation (CITATION.cff) 

abstract: "A simple implementation of the Nota-Lang editor in a docker container for quickly getting started with Nota-Lang without installation of Node"
title: "Nota Editor Docker Implementation"
url: "https://github.com/MStolen/nota-lang-editor"
license: MIT
cff-version: 1.2.0
message: "If you use this software in a presentation or published work, please cite it as below."
authors:
  - family-names: "Steele"
    given-names: "Alec Maxwell"
    orcid: "https://orcid.org/0000-0001-5839-7360"

GitHub Events

Total
Last Year

Dependencies

Dockerfile docker
  • node 18-alpine build
docker-compose.yml docker
  • nota-edit 0.2.0