Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/izmjs/izmjs.github.io

Official website
https://github.com/izmjs/izmjs.github.io

Last synced: about 5 hours ago
JSON representation

Official website

Host: GitHub
URL: https://github.com/izmjs/izmjs.github.io
Owner: izmjs
License: mit
Created: 2019-08-21T04:11:44.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-01-11T22:12:06.000Z (almost 2 years ago)
Last Synced: 2024-03-22T15:10:44.445Z (8 months ago)
Language: JavaScript
Homepage: https://izmjs.netlify.app/
Size: 3.02 MB
Stars: 19
Watchers: 4
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

izmjs docs

[![Netlify Status](https://api.netlify.com/api/v1/badges/ce1882e9-e428-41b4-9ef0-8151f3125e09/deploy-status)](https://app.netlify.com/sites/izmjs/deploys)

#### 🚀 Quick start

[Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and clone the project:

```shell
git clone [email protected]:/izmjs.github.io.git
```

#### Start developing.

Navigate into your new site’s directory and start it up.

```shell
cd izmjs.github.io/
npm install # Install dependencies
npm start # Start developing
```

Open the source code and start editing!

Your site is now running at http://localhost:8000

Note: You'll also see a second link: http://localhost:8000/___graphql.

> This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

#### 🧐 Want to contribute ?

The docs are separated into sections and subsections

If you want to create a new section add a new folder under `izmjs.github.io/src/docs` and make sure the name of your folder is snake-cased afterwards you can go to that section and create a new `mdx` file (also snake-cased) with title of the feature you want to cover.

If your feature you're covering is a bit long, make sure to divide it up with subtitles for example: `## feature` so that the Table of contents can pick it up and display it

When you're done go to the `/config` folder you'll find `sidebar.yml` where you can link your newly added features and so they can show up on the site's navigation.

```yaml
- label: "Section"
link: "/section"
items:
- label: "Sub Section"
link: "section/sub-section"
- label: "Sub Section"
link: "section/sub-section"
- label: "Sub Section"
link: "section/sub-section"
```