https://github.com/gjsify/doc

Gjs and node-gtk Typescript API documentation generator + typedoc theme + typedoc plugin
https://github.com/gjsify/doc

documentation gjs node-gtk plugin theme typedoc typescript

Last synced: about 1 year ago
JSON representation

Gjs and node-gtk Typescript API documentation generator + typedoc theme + typedoc plugin

• Host: GitHub
• URL: https://github.com/gjsify/doc
• Owner: gjsify
• License: agpl-3.0
• Created: 2021-02-19T12:06:58.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T21:33:34.000Z (almost 2 years ago)
• Last Synced: 2025-03-02T21:18:02.049Z (over 1 year ago)
• Topics: documentation, gjs, node-gtk, plugin, theme, typedoc, typescript
• Language: TypeScript
• Homepage: https://gjsify.org/pages/api-references
• Size: 348 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# doc

Gjs and node-gtk Typescript API documentation

## Submodules

This repository has submodules, so you need to clone this repository including this submodules:

```bash

git clone --recursive https://github.com/gjsify/doc.git

```

You can also clone the submodules afterwards:

```bash

git clone https://github.com/gjsify/doc.git

cd doc

git submodule update --init --recursive

```

If you want to pull updates from this repository you should also pull the submodules:

```bash

git pull --recurse-submodules

```

## Generate documentations

Simply execute:

```bash

yarn install

yarn run build

yarn run start

```

## TODO

Get images from https://gitlab.gnome.org/GNOME/gtk/-/tree/main/docs/reference/gtk/images

## FAQ

Problem: I get the following error:

```

FATAL ERROR: Scavenger: semi-space copy Allocation failed - JavaScript heap out of memory

```

Solution:

```bash

sudo sysctl -w vm.max_map_count=262144

NODE_OPTIONS=--max-old-space-size=25600 yarn run start

```