Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 2.2 KB

README.md

File metadata and controls

78 lines (50 loc) · 2.2 KB
Raw

simple-odf

Open Document Format made easy using pure JavaScript and Node.js

Dependencies Known Vulnerabilities Version

Getting Started

Install simple-odf using npm:

npm install --save simple-odf

Create your first document.

const simpleOdf = require("simple-odf");

const document = new simpleOdf.TextDocument();

document.addHeadline("My First Document");

const p1 = document.addParagraph("The quick, brown fox jumps over a lazy dog.");
p1.appendTextContent("\nThe five boxing wizards jump quickly\n\n");
p1.appendHyperlink("Visit me", "http://example.org/");

document.addHeadline("Credits", 2);

document.addParagraph("This was quite easy. Do you want to know why?");

const list = document.addList();
list.addItem("one-liner setup");
list.addItem("just write like you would do in a full-blown editor");

document.saveFlat("/home/homer/My_first_document.fodf");

Contributing

If you want to contribute to simple-odf, you are very welcome. Send issues and pull requests with your ideas.

Pull Requests

Before submitting a pull request, please make sure the following is done...

  1. Fork the repo and create your branch from master. A guide on how to fork a repository: https://help.github.com/articles/fork-a-repo/

    Open terminal and type:

    git clone https://github.com/<your_username>/simple-odf
cd simple-odf
git checkout -b my_branch

  2. simple-odf uses npm for running development scripts. If you haven't already done so, please install npm.

  3. Run npm install.

    npm install

  4. If you've added code, add tests. You can use watch mode that continuously observes changed files to make your life easier.

    npm test -- --watch

License

By contributing to simple-odf, you agree that your contributions will be licensed under its MIT license.