Skip to content

Commit

Permalink
chore: rename plugin to "Charts", close #109
Browse files Browse the repository at this point in the history
  • Loading branch information
phibr0 committed Jan 26, 2024
1 parent 56b65dd commit 6638146
Show file tree
Hide file tree
Showing 10 changed files with 456 additions and 364 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Obsidian-Charts [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/phibr0/obsidian-charts)](https://github.com/phibr0/obsidian-charts/releases) [![Release Obsidian Plugin](https://github.com/phibr0/obsidian-charts/actions/workflows/release.yml/badge.svg)](https://github.com/phibr0/obsidian-charts/actions/workflows/release.yml) ![GitHub all releases](https://img.shields.io/github/downloads/phibr0/obsidian-charts/total)

This plugin lets you create interactive Charts in [Obsidian](https://www.obsidian.md).
This plugin lets you create interactive Charts in
[Obsidian](https://www.obsidian.md).

**[Read the Documentation](https://charts.phib.ro/)**

## How to install

1. Go to **Community Plugins** in your [Obsidian](https://www.obsidian.md) Settings and **disable** Safe Mode
2. Click on **Browse** and search for "Obsidian Charts"
1. Go to **Community Plugins** in your [Obsidian](https://www.obsidian.md)
Settings and **disable** Safe Mode
2. Click on **Browse** and search for "Charts"
3. Click install
4. Toggle the Plugin on in the **Community Plugins** Tab

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/Chart Types/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 4

# Types

Obsidian Charts provides a variety of different Charts.
Charts provides a variety of different Charts.

- [Bar Chart](Bar)
- [Line Chart](Line)
Expand Down
3 changes: 2 additions & 1 deletion docusaurus/docs/More Resources.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Some people share their creations made with Obsidian Charts. Here is a list of some of them:
Some people share their creations made with Charts. Here is a list of some of
them:

- [Mulfok's Periodic Note Templates](https://github.com/mulfok/periodic-note-templates)

Expand Down
78 changes: 40 additions & 38 deletions docusaurus/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,61 +4,63 @@ sidebar_position: 1

# Getting started

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/phibr0/obsidian-charts)](https://github.com/phibr0/obsidian-charts/releases) ![GitHub all releases](https://img.shields.io/github/downloads/phibr0/obsidian-charts/total)
[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/phibr0/obsidian-charts)](https://github.com/phibr0/obsidian-charts/releases)
![GitHub all releases](https://img.shields.io/github/downloads/phibr0/obsidian-charts/total)

Obsidian Charts let's you create interactive Charts inside [Obsidian](https://www.obsidian.md).
Charts let's you create interactive Charts inside
[Obsidian](https://www.obsidian.md).

## What this can do

import { Bar, Line } from "react-chartjs-2";
import { Chart, registerables } from "chart.js";
import { Bar, Line } from 'react-chartjs-2';
import { Chart, registerables } from 'chart.js';
Chart.register(...registerables);

You can create Charts like this one in your markdown notes.

<div style={{width: "50%"}}>
<div style={{ width: '50%' }}>
<Bar
datasetIdKey="id"
data={{
height: "10px",
labels: ["Friday", "Saturday", "Sunday"],
datasets: [
{
id: 1,
label: "Sleep",
data: [6, 8, 9],
backgroundColor: [
"rgba(255, 99, 132, 0.2)",
"rgba(54, 162, 235, 0.2)",
"rgba(255, 206, 86, 0.2)",
],
borderColor: [
"rgba(255, 99, 132, 1)",
"rgba(54, 162, 235, 1)",
"rgba(255, 206, 86, 1)",
],
borderWidth: 2,
},
],
}}
options={{
scales: {
datasetIdKey="id"
data={{
height: '10px',
labels: ['Friday', 'Saturday', 'Sunday'],
datasets: [
{
id: 1,
label: 'Sleep',
data: [6, 8, 9],
backgroundColor: [
'rgba(255, 99, 132, 0.2)',
'rgba(54, 162, 235, 0.2)',
'rgba(255, 206, 86, 0.2)',
],
borderColor: [
'rgba(255, 99, 132, 1)',
'rgba(54, 162, 235, 1)',
'rgba(255, 206, 86, 1)',
],
borderWidth: 2,
},
],
}}
options={{
scales: {
x: {
grid: {
color: "rgba(128, 128, 128, 0.2)",
}
color: 'rgba(128, 128, 128, 0.2)',
},
},
y: {
grid: {
color: "rgba(128, 128, 128, 0.2)",
}
color: 'rgba(128, 128, 128, 0.2)',
},
},
}
}}
/>
},
}}
/>
</div>

**But how?** First [install the Obsidian Charts Plugin](/installation).
**But how?** First [install the Charts Plugin](/installation).

:::info SUPPORTING

Expand Down
11 changes: 6 additions & 5 deletions docusaurus/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ sidebar_position: 2
1. Open settings > Community plugins
2. Disable Safe mode
3. Click Browse community plugins
4. Search for "Obsidian Charts"
4. Search for "Charts"
5. Install it
6. Activate it under installed plugins

## From GitHub (manual)

1. Download the [latest release](https://github.com/phibr0/obsidian-charts/releases/latest)
2. Move `manifest.json` and `main.js` to `<vault>/.obsidian/plugins/obsidian-charts`
1. Download the
[latest release](https://github.com/phibr0/obsidian-charts/releases/latest)
2. Move `manifest.json` and `main.js` to
`<vault>/.obsidian/plugins/obsidian-charts`
3. Reload Obsidian (CTRL + R)
4. Go to settings and disable safe mode
5. Enable `Obsidian Charts`

5. Enable `Charts`
17 changes: 9 additions & 8 deletions docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Obsidian Charts',
tagline: 'Create editable, interactive and animated Charts in Obsidian via Chart.js ',
title: 'Charts',
tagline:
'Create editable, interactive and animated Charts in Obsidian via Chart.js ',
url: 'https://charts.phibr0.de',
baseUrl: '/',
onBrokenLinks: 'throw',
Expand Down Expand Up @@ -43,7 +44,7 @@ const config = {
type: 'doc',
docId: 'index',
position: 'left',
label: 'Obsidian Charts Docs',
label: 'Charts Docs',
},
{
href: 'https://github.com/phibr0/obsidian-charts',
Expand All @@ -65,17 +66,17 @@ const config = {
],
},
{
title: 'Contact',
title: 'Contact',
items: [
{
label: 'GitHub',
to: 'https://github.com/phibr0'
to: 'https://github.com/phibr0',
},
{
label: 'Support me',
to: 'https://buymeacoffe.com/phibr0'
}
]
to: 'https://buymeacoffe.com/phibr0',
},
],
},
{
title: 'More',
Expand Down
4 changes: 2 additions & 2 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-charts",
"name": "Obsidian Charts",
"version": "3.8.2",
"name": "Charts",
"version": "3.9.0",
"minAppVersion": "0.12.7",
"description": "This Plugin lets you create Charts within Obsidian",
"author": "phibr0",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-charts",
"version": "0.10.8",
"version": "3.9.0",
"description": "This Plugin lets you create Charts within Obsidian",
"main": "main.js",
"scripts": {
Expand Down
Loading

0 comments on commit 6638146

Please sign in to comment.