https://github.com/wanadev/obsidianjs

The ObsidianJS Framework
https://github.com/wanadev/obsidianjs

Last synced: 23 days ago
JSON representation

The ObsidianJS Framework

• Host: GitHub
• URL: https://github.com/wanadev/obsidianjs
• Owner: wanadev
• License: other
• Created: 2018-06-15T13:05:13.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T00:24:44.000Z (about 2 years ago)
• Last Synced: 2025-04-02T13:04:13.336Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://wanadev.github.io/obsidianjs/
• Size: 7.52 MB
• Stars: 5
• Watchers: 11
• Forks: 0
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Framework

[![Build Status](https://travis-ci.org/wanadev/obsidianjs.svg?branch=master)](https://travis-ci.org/wanadev/obsidianjs)

## Running Linter and Tests

To run the linter:

    npx eslint .

To run all tests:

    npm test

To run all test of a specific module:

    npm test modules/my-module/

To only run test on changed files:

    npm test -- -o

## Build Documentation

### Linux

    apt install virtualenv

    npm run build-doc

### Windows

* Download Python https://www.python.org/downloads/

* Install Python, don't forget to check the checkbox to add path variables to windows

* Open shell as an administrator

* run `pip install virtualenv`

You can now run the following command to build doc:

    npm run build-doc

## Generate TS types

`npx tsc -p ./obsidian`