Updated Naming Convention

This commit is contained in:
JK 2026-06-05 14:50:35 +02:00
parent 2cf270523a
commit 4aa6d9cdac
21 changed files with 82 additions and 82 deletions

View file

@ -5,9 +5,9 @@ body:
attributes:
label: "⚠️ Please check that this feature request hasn't been suggested before."
options:
- label: "I searched previous [Ideas in Discussions](https://github.com/YouFoundJK/ObsiTeXcore/discussions/categories/ideas) and didn't find any similar feature requests."
- label: "I searched previous [Ideas in Discussions](https://github.com/YouFoundJK/TeXcore/discussions/categories/ideas) and didn't find any similar feature requests."
required: true
- label: "I searched previous [Issues](https://github.com/YouFoundJK/ObsiTeXcore/issues) and didn't find any similar feature requests."
- label: "I searched previous [Issues](https://github.com/YouFoundJK/TeXcore/issues) and didn't find any similar feature requests."
required: true
- type: textarea

View file

@ -1,12 +1,12 @@
name: Bug Report
description: Create a bug report to help us improve ObsiTeXcore
description: Create a bug report to help us improve TeXcore
labels: ['bug']
body:
- type: markdown
attributes:
value: |
## Before you start
Please **make sure you are on the latest version of ObsiTeXcore.**
Please **make sure you are on the latest version of TeXcore.**
If you encountered the issue after you installed, updated, or reloaded the plugin, **please try restarting Obsidian before reporting the bug**.
- type: checkboxes
@ -15,7 +15,7 @@ body:
label: "Please check that this issue hasn't been reported before."
description: 'The **Label filters** may help make your search more focused.'
options:
- label: "I searched previous [Bug Reports](https://github.com/YouFoundJK/ObsiTeXcore/issues?q=state%3Aopen%20label%3Abug) and didn't find any similar reports."
- label: "I searched previous [Bug Reports](https://github.com/YouFoundJK/TeXcore/issues?q=state%3Aopen%20label%3Abug) and didn't find any similar reports."
required: true
- type: textarea
@ -86,7 +86,7 @@ body:
id: plugin-version
attributes:
label: Plugin Version
description: Which ObsiTeXcore version are you using?
description: Which TeXcore version are you using?
placeholder: 'Enter plugin version here.'
validations:
required: true

View file

@ -6,11 +6,11 @@ body:
attributes:
value: |
## Feature Requests have moved to Discussions
Please [submit feature requests as Discussions](https://github.com/YouFoundJK/ObsiTeXcore/discussions/categories/ideas) so that they can be voted on and prioritized.
Please [submit feature requests as Discussions](https://github.com/YouFoundJK/TeXcore/discussions/categories/ideas) so that they can be voted on and prioritized.
- type: checkboxes
attributes:
label: Submit on Discussions
description: Please submit your feature request as a Discussion.
options:
- label: I will submit my feature request as a [Discussion](https://github.com/YouFoundJK/ObsiTeXcore/discussions/categories/ideas).
- label: I will submit my feature request as a [Discussion](https://github.com/YouFoundJK/TeXcore/discussions/categories/ideas).
required: true

View file

@ -41,7 +41,7 @@ Acceptance Criteria:
- [ ] Chore / maintenance <!-- Add `Related Issue / Discussion #__ if applicable-->
## Code Quality Checklist (MANDATORY)
*Please read and verify you have adhered to all guidelines outlined in [CONTRIBUTING.md](https://github.com/YouFoundJK/ObsiTeXcore/blob/master/CONTRIBUTING.md).*
*Please read and verify you have adhered to all guidelines outlined in [CONTRIBUTING.md](https://github.com/YouFoundJK/TeXcore/blob/master/CONTRIBUTING.md).*
- **[SOLID](https://en.wikipedia.org/wiki/SOLID), [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)**:
- [ ] Designed polymorphically where appropriate.

View file

@ -1,6 +1,6 @@
# 🎉 Contributing to ObsiTeXcore
# 🎉 Contributing to TeXcore
ObsiTeXcore is open to contributions, and were excited to have you here! This guide will help you get set up for local development.
TeXcore is open to contributions, and were excited to have you here! This guide will help you get set up for local development.
> We welcome any and all types of PR, including ones assisted by AI. To ensure the codebase is clean and up to standard, we strictly adhere to the following principles.
@ -51,4 +51,4 @@ All build output will appear in the root directory (`main.js` and `styles.css`)
> 💡 **Recommended:** Use the [Hot Reload plugin](https://github.com/pjeby/hot-reload) to make development smoother — it auto-reloads your plugin changes.
Thanks for helping improve ObsiTeXcore! 🎨📝
Thanks for helping improve TeXcore! 🎨📝

View file

@ -1,13 +1,13 @@
<div align="right">
<img src="https://img.shields.io/github/downloads/YouFoundJK/ObsiTeXcore/total?label=Downloads" alt="Downloads" />
<a href="https://youfoundjk.github.io/ObsiTeXcore/"><img src="https://img.shields.io/badge/Version-v_0.0.1-blue" alt="Version" /></a>
<img src="https://img.shields.io/github/downloads/YouFoundJK/TeXcore/total?label=Downloads" alt="Downloads" />
<a href="https://youfoundjk.github.io/TeXcore/"><img src="https://img.shields.io/badge/Version-v_0.0.1-blue" alt="Version" /></a>
</div>
# ObsiTeXcore for Obsidian
# TeXcore for Obsidian
A minimalistic [Obsidian.md](https://obsidian.md/) plugin for automatic equation numbering and referencing.
📚 **[Full Documentation](https://youfoundjk.github.io/ObsiTeXcore/)**
📚 **[Full Documentation](https://youfoundjk.github.io/TeXcore/)**
## Key Differences from Original
@ -80,13 +80,13 @@ Use the "Fix callout equations" command to repair broken indentation.
### From Community Plugins
1. Open Obsidian Settings → **Community plugins**
2. Click **Browse** and search for "ObsiTeXcore"
2. Click **Browse** and search for "TeXcore"
3. Click **Install**, then **Enable**
### Manual Installation
1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/YouFoundJK/ObsiTeXcore/releases)
2. Create folder: `<vault>/.obsidian/plugins/obsitexcore/`
1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/YouFoundJK/TeXcore/releases)
2. Create folder: `<vault>/.obsidian/plugins/TeXcore/`
3. Copy the files into this folder
4. Restart Obsidian and enable the plugin
@ -109,7 +109,7 @@ Use the "Fix callout equations" command to repair broken indentation.
## Configuration
See the [Settings Reference](https://youfoundjk.github.io/ObsiTeXcore/configuration/settings/) for all configuration options.
See the [Settings Reference](https://youfoundjk.github.io/TeXcore/configuration/settings/) for all configuration options.
## License

View file

@ -2,7 +2,7 @@
window.cleanUmamiUrl = function (type, payload) {
if (payload && payload.url) {
// Strip the repository name from the URL prefix for cleaner dashboard visibility
payload.url = payload.url.replace('/ObsiTeXcore', '') || '/';
payload.url = payload.url.replace('/TeXcore', '') || '/';
}
return payload;
};
@ -32,7 +32,7 @@ function investigateUmamiEvent(eventName, eventData) {
if (window.umami && typeof window.umami.track === 'function') {
// Ensure the repository subdirectory name is stripped from custom events too
if (eventData && eventData.page) {
eventData.page = eventData.page.replace('/ObsiTeXcore', '') || '/';
eventData.page = eventData.page.replace('/TeXcore', '') || '/';
}
window.umami.track(eventName, eventData);

View file

@ -1,6 +1,6 @@
# Settings Reference
Complete reference for all ObsiTeXcore settings.
Complete reference for all TeXcore settings.
## Equation Numbering & Referencing

View file

@ -1,6 +1,6 @@
# Equation Numbering & Referencing
The core feature of ObsiTeXcore is automatic equation numbering using LaTeX `\tag{}` commands and smart referencing via internal links.
The core feature of TeXcore is automatic equation numbering using LaTeX `\tag{}` commands and smart referencing via internal links.
## How Equation IDs Work

View file

@ -5,13 +5,13 @@
### From Community Plugins
1. Open Obsidian Settings → **Community plugins**
2. Click **Browse** and search for "ObsiTeXcore"
2. Click **Browse** and search for "TeXcore"
3. Click **Install**, then **Enable**
### Manual Installation
1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/YouFoundJK/ObsiTeXcore/releases)
2. Create folder: `<vault>/.obsidian/plugins/obsitexcore/`
1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/YouFoundJK/TeXcore/releases)
2. Create folder: `<vault>/.obsidian/plugins/TeXcore/`
3. Copy the downloaded files into this folder
4. Restart Obsidian and enable the plugin

View file

@ -1,4 +1,4 @@
# ObsiTeXcore
# TeXcore
A minimalistic Obsidian plugin for automatic equation numbering, referencing with support for PDE exports and .

View file

@ -2,7 +2,7 @@
<div class="md-footer-meta custom-footer" role="contentinfo">
<div class="md-footer-meta__inner md-grid">
<section class="custom-footer__brand" aria-label="Project">
<div class="custom-footer__title">ObsiTeXcore</div>
<div class="custom-footer__title">TeXcore</div>
<p class="custom-footer__tagline">
A powerful indexing & referencing system for theorems & equations in Obsidian.
</p>
@ -19,16 +19,16 @@
<nav class="custom-footer__column" aria-label="Key docs">
<h3>Documentation</h3>
<a href="https://youfoundjk.github.io/ObsiTeXcore/">Docs Home</a>
<a href="https://youfoundjk.github.io/ObsiTeXcore/getting-started/">Getting Started</a>
<a href="https://youfoundjk.github.io/ObsiTeXcore/configuration/settings/"
<a href="https://youfoundjk.github.io/TeXcore/">Docs Home</a>
<a href="https://youfoundjk.github.io/TeXcore/getting-started/">Getting Started</a>
<a href="https://youfoundjk.github.io/TeXcore/configuration/settings/"
>Settings Reference</a
>
</nav>
<nav class="custom-footer__column" aria-label="Project and support links">
<h3>Project</h3>
<a href="https://github.com/YouFoundJK/ObsiTeXcore" target="_blank" rel="noopener"
<a href="https://github.com/YouFoundJK/TeXcore" target="_blank" rel="noopener"
>GitHub Repository</a
>
<a href="https://github.com/YouFoundJK" target="_blank" rel="noopener"

View file

@ -35,7 +35,7 @@ async function build() {
const rootDir = process.cwd();
const devEnvDir = path.join(
rootDir,
'../plugin-full-calendar/obsidian-dev-vault/.obsidian/plugins/ObsiTeXcore'
'../plugin-full-calendar/obsidian-dev-vault/.obsidian/plugins/TeXcore'
);
// Ensure dev output directory exists

View file

@ -1,11 +1,11 @@
{
"id": "obsitexcore",
"name": "ObsiTeXcore",
"id": "texcore",
"name": "TeXcore",
"version": "0.0.1",
"minAppVersion": "1.3.5",
"description": "A powerful indexing & referencing system for theorems & equations in your vault. Bring LaTeX-like workflow into Obsidian with theorem environments, automatic equation numbering, and more.",
"description": "Automatic equation numbering, Tex Diagrams rendering, and more for Obsidian.md.",
"author": "Jovi Koikkara",
"authorUrl": "https://github.com/YouFoundJK",
"fundingUrl": "https://github.com/YouFoundJK",
"isDesktopOnly": false
"isDesktopOnly": true
}

View file

@ -1,8 +1,8 @@
site_name: ObsiTeXcore
site_name: TeXcore
site_description: A powerful indexing & referencing system for theorems & equations in your vault.
site_url: https://youfoundjk.github.io/ObsiTeXcore/
repo_name: YouFoundJK/ObsiTeXcore
repo_url: https://github.com/YouFoundJK/ObsiTeXcore
site_url: https://youfoundjk.github.io/TeXcore/
repo_name: YouFoundJK/TeXcore
repo_url: https://github.com/YouFoundJK/TeXcore
theme:
name: material
@ -86,7 +86,7 @@ plugins:
enable_creation_date: true
type: datetime
- git-committers:
repository: YouFoundJK/ObsiTeXcore
repository: YouFoundJK/TeXcore
cache_dir: .cache/plugin/git-committers
branch: main
@ -106,7 +106,7 @@ extra:
note: Thanks for your feedback!
social:
- icon: fontawesome/brands/github
link: https://github.com/YouFoundJK/ObsiTeXcore
link: https://github.com/YouFoundJK/TeXcore
nav:
- Home: index.md

View file

@ -1,5 +1,5 @@
{
"name": "obsitexcore",
"name": "TeXcore",
"version": "0.0.1",
"description": "Automatic equation numbering, Tex Diagrams rendering, and more for Obsidian.md",
"main": "main.js",

View file

@ -1,6 +1,6 @@
{
"settings": {
"title": "ObsiTeXcore settings",
"title": "TeXcore settings",
"description": "Switch between focused setting groups to keep configuration lighter and easier to scan.",
"tab": {
"general": "General",
@ -24,7 +24,7 @@
},
"modals": {
"whatsNew": {
"title": "What's new in ObsiTeXcore",
"title": "What's new in TeXcore",
"openSettings": "Open settings",
"supportKofi": "Support development / ko-fi"
}

View file

@ -1,6 +1,6 @@
/**
* @file changelogData.ts
* @brief Version changelog data for ObsiTeXcore.
* @brief Version changelog data for TeXcore.
*/
export interface ChangelogItem {

View file

@ -15,7 +15,7 @@ export interface DocsLink {
path: string;
}
const DOCS_ROOT = 'https://youfoundjk.github.io/ObsiTeXcore/';
const DOCS_ROOT = 'https://youfoundjk.github.io/TeXcore/';
export function toDocsUrl(path: string): string {
return `${DOCS_ROOT}${path.replace(/^\/+/, '')}`;

View file

@ -60,18 +60,18 @@ export class MathSettingTab extends PluginSettingTab {
const { containerEl } = this;
containerEl.empty();
const shellEl = containerEl.createDiv('obsitexcore-settings-shell');
const shellEl = containerEl.createDiv('TeXcore-settings-shell');
// Header
const headerEl = shellEl.createDiv('obsitexcore-settings-header');
const headerEl = shellEl.createDiv('TeXcore-settings-header');
headerEl.createEl('p', {
text: t('settings.description'),
cls: 'obsitexcore-settings-header-desc'
cls: 'TeXcore-settings-header-desc'
});
// Tabs & Search row
const tabsRowEl = shellEl.createDiv('obsitexcore-settings-tabs-row');
const tabsEl = tabsRowEl.createDiv('obsitexcore-settings-tabs');
const tabsRowEl = shellEl.createDiv('TeXcore-settings-tabs-row');
const tabsEl = tabsRowEl.createDiv('TeXcore-settings-tabs');
TABS.forEach(tab => {
const isActive = tab.id === this.activeTab;
@ -89,16 +89,16 @@ export class MathSettingTab extends PluginSettingTab {
});
// Search wrap
const searchWrapEl = tabsRowEl.createDiv('obsitexcore-settings-search-wrap');
const searchWrapEl = tabsRowEl.createDiv('TeXcore-settings-search-wrap');
const searchButtonEl = searchWrapEl.createEl('button', {
cls: 'clickable-icon obsitexcore-settings-search-trigger'
cls: 'clickable-icon TeXcore-settings-search-trigger'
});
searchButtonEl.type = 'button';
searchButtonEl.ariaLabel = 'Search settings';
setIcon(searchButtonEl, 'search');
const inputWrapEl = searchWrapEl.createDiv('obsitexcore-settings-search-input-wrap');
const inputWrapEl = searchWrapEl.createDiv('TeXcore-settings-search-input-wrap');
setCssProps(inputWrapEl, {
position: 'relative',
width: this.searchExpanded || this.searchQuery ? '170px' : '0px',
@ -107,14 +107,14 @@ export class MathSettingTab extends PluginSettingTab {
});
const searchInputEl = inputWrapEl.createEl('input', {
cls: 'obsitexcore-settings-search-input'
cls: 'TeXcore-settings-search-input'
});
searchInputEl.type = 'text';
searchInputEl.placeholder = 'Search settings...';
searchInputEl.value = this.searchQuery;
const clearButtonEl = inputWrapEl.createEl('button', {
cls: 'clickable-icon obsitexcore-settings-search-clear'
cls: 'clickable-icon TeXcore-settings-search-clear'
});
clearButtonEl.type = 'button';
clearButtonEl.ariaLabel = 'Clear search';
@ -170,7 +170,7 @@ export class MathSettingTab extends PluginSettingTab {
});
// Content Panel
const contentEl = shellEl.createDiv('obsitexcore-settings-content');
const contentEl = shellEl.createDiv('TeXcore-settings-content');
this.renderSettingsContent(contentEl);
// Footer
@ -184,10 +184,10 @@ export class MathSettingTab extends PluginSettingTab {
if (!query) {
const activeTab = TABS.find(t => t.id === this.activeTab);
if (activeTab) {
const introEl = containerEl.createDiv('obsitexcore-settings-category-intro');
const introEl = containerEl.createDiv('TeXcore-settings-category-intro');
introEl.createEl('p', { text: t(activeTab.descKey) });
}
const panelEl = containerEl.createDiv('obsitexcore-settings-panel');
const panelEl = containerEl.createDiv('TeXcore-settings-panel');
this.renderCategoryContent(this.activeTab, panelEl);
return;
}
@ -196,12 +196,12 @@ export class MathSettingTab extends PluginSettingTab {
for (const tab of TABS) {
if (tab.id === 'changelog') continue; // Skip changelog in search filters
const sectionEl = containerEl.createDiv('obsitexcore-settings-search-section');
const introEl = sectionEl.createDiv('obsitexcore-settings-category-intro');
const sectionEl = containerEl.createDiv('TeXcore-settings-search-section');
const introEl = sectionEl.createDiv('TeXcore-settings-category-intro');
new Setting(introEl).setName(t(tab.labelKey)).setHeading();
introEl.createEl('p', { text: t(tab.descKey) });
const panelEl = sectionEl.createDiv('obsitexcore-settings-panel');
const panelEl = sectionEl.createDiv('TeXcore-settings-panel');
this.renderCategoryContent(tab.id, panelEl);
const sectionHasMatches = this.applySearchFilter(panelEl, query);
@ -213,7 +213,7 @@ export class MathSettingTab extends PluginSettingTab {
}
if (!hasAnyMatches) {
const emptyEl = containerEl.createDiv('obsitexcore-settings-search-empty');
const emptyEl = containerEl.createDiv('TeXcore-settings-search-empty');
emptyEl.createEl('p', { text: `No settings match "${query}".` });
}
}
@ -857,10 +857,10 @@ export class MathSettingTab extends PluginSettingTab {
private renderChangelog(containerEl: HTMLElement): void {
new Setting(containerEl).setName(t('settings.header.whatsNew')).setHeading();
const changelogList = containerEl.createDiv('obsitexcore-changelog-view-list');
const changelogList = containerEl.createDiv('TeXcore-changelog-view-list');
changelogData.forEach(version => {
const verContainer = changelogList.createDiv('obsitexcore-changelog-version-container');
const verContainer = changelogList.createDiv('TeXcore-changelog-version-container');
new Setting(verContainer)
.setName(`Version ${version.version} (${version.date})`)
.setHeading();
@ -915,21 +915,21 @@ export class MathSettingTab extends PluginSettingTab {
linksContainer.createEl('a', {
text: t('settings.footer.supportOnKofi'),
attr: {
href: 'https://youfoundjk.github.io/ObsiTeXcore/donation/ko-fi'
href: 'https://youfoundjk.github.io/TeXcore/donation/ko-fi'
},
cls: 'full-calendar-settings-footer-link'
});
linksContainer.createEl('a', {
text: t('settings.footer.suggestFeature'),
attr: {
href: 'https://github.com/YouFoundJK/ObsiTeXcore/discussions'
href: 'https://github.com/YouFoundJK/TeXcore/discussions'
},
cls: 'full-calendar-settings-footer-link'
});
linksContainer.createEl('a', {
text: t('settings.footer.reportBug'),
attr: {
href: 'https://github.com/YouFoundJK/ObsiTeXcore/issues'
href: 'https://github.com/YouFoundJK/TeXcore/issues'
},
cls: 'full-calendar-settings-footer-link'
});

View file

@ -20,13 +20,13 @@ export class WhatsNewModal extends Modal {
onOpen() {
const { contentEl } = this;
contentEl.empty();
contentEl.addClass('obsitexcore-whats-new-modal');
contentEl.addClass('TeXcore-whats-new-modal');
// Header
const headerRow = contentEl.createDiv('obsitexcore-whats-new-header-row');
const headerRow = contentEl.createDiv('TeXcore-whats-new-header-row');
headerRow.createEl('h2', { text: t('modals.whatsNew.title') });
const seeAllButtonWrap = headerRow.createDiv('obsitexcore-whats-new-header-actions');
const seeAllButtonWrap = headerRow.createDiv('TeXcore-whats-new-header-actions');
new ButtonComponent(seeAllButtonWrap)
.setButtonText(t('modals.whatsNew.openSettings'))
.onClick(() => {
@ -39,15 +39,15 @@ export class WhatsNewModal extends Modal {
});
// Content container
const bodyEl = contentEl.createDiv('obsitexcore-whats-new-body');
const bodyEl = contentEl.createDiv('TeXcore-whats-new-body');
const latestVersion = changelogData[0];
const versionHeader = bodyEl.createDiv('obsitexcore-whats-new-version-header');
const versionHeader = bodyEl.createDiv('TeXcore-whats-new-version-header');
versionHeader.createEl('h3', {
text: `Version ${latestVersion.version} (${latestVersion.date})`
});
const changeList = bodyEl.createDiv('obsitexcore-whats-new-list');
const changeList = bodyEl.createDiv('TeXcore-whats-new-list');
latestVersion.changes.forEach(change => {
const colonIndex = change.description.indexOf(':');
let title: string;
@ -85,18 +85,18 @@ export class WhatsNewModal extends Modal {
});
// Donation Footer
const donationFooter = contentEl.createDiv('obsitexcore-whats-new-donation-footer');
const donationFooter = contentEl.createDiv('TeXcore-whats-new-donation-footer');
donationFooter.createEl('p', {
text: 'ObsiTeXcore is built to bring LaTeX-like equation indexing and referencing workflows to Obsidian. If this plugin provides value to you, please consider supporting the development!',
cls: 'obsitexcore-whats-new-donation-message'
text: 'TeXcore is built to bring LaTeX-like equation indexing and referencing workflows to Obsidian. If this plugin provides value to you, please consider supporting the development!',
cls: 'TeXcore-whats-new-donation-message'
});
const donationActions = donationFooter.createDiv('obsitexcore-whats-new-donation-actions');
const donationActions = donationFooter.createDiv('TeXcore-whats-new-donation-actions');
new ButtonComponent(donationActions)
.setButtonText(t('modals.whatsNew.supportKofi'))
.setCta()
.onClick(() => {
window.open('https://youfoundjk.github.io/ObsiTeXcore/donation/ko-fi', '_blank');
window.open('https://youfoundjk.github.io/TeXcore/donation/ko-fi', '_blank');
});
}