Skip to content

Commit 3769b82

Browse files
authored
Merge pull request #83 from wheelercj/doc-goals
Improve description of Stardown's goals
2 parents 303593c + 1cfbff9 commit 3769b82

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

docs/develop.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Stardown development
22

3-
I wrote some general extension development tips in [Making browser extensions](https://til.chriswheeler.dev/making-browser-extensions/).
3+
I wrote some general extension development tips in [Making browser extensions](https://chriswheeler.dev/posts/making-browser-extensions/). For more context about markdown itself, see [CommonMark: A Formal Specification For Markdown — Smashing Magazine](https://www.smashingmagazine.com/2020/12/commonmark-formal-specification-markdown/).
44

5-
## Priorities
5+
## Goals
66

7-
To keep Stardown easy to use, I would like to avoid having a popup and to have only one context menu option visible at a time. The options page can have many options as long as they are well organized and useful. Stardown's output to the clipboard should render well on at least Obsidian and GitHub, if not also other markdown renderers like VS Code and Discord.
7+
Stardown's main goal is to be so simple, fast, reliable, and flexible that people think of it as "it's like Ctrl+C but it keeps formatting". It should probably only ever have one keyboard shortcut, no popup, and show only one context menu option at a time. The options page can have many options as long as they are well organized and useful. Stardown's output should render well on at least Obsidian and GitHub, if not also other markdown renderers like Google Docs, VS Code, Discourse, GitLab, Stack Overflow, Joplin, Reddit, and Discord.
88

9-
I would like to keep Stardown relatively simple so that it's reliable, has few bugs that get fixed quickly, and is easy to maintain.
9+
I would also like to keep Stardown's code relatively simple so that it's reliable, has few bugs that get fixed quickly, and is easy to maintain.
1010

1111
## Installing Stardown from source for development
1212

src/tableConverter.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
Copyright 2024 Chris Wheeler
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
117
/**
218
* A TableConverter is an object that assists with converting an HTML table to a
319
* markdown table. A TableConverter instance should not be reused for multiple tables.

0 commit comments

Comments
 (0)