@ -18,45 +18,53 @@ You can also contact us [on Nostr](https://next-alexandria.gitcitadel.eu/events?
Make sure that you have [Node.js](https://nodejs.org/en/download/package-manager) (v22 or above) or [Deno](https://docs.deno.com/runtime/getting_started/installation/) (v2) installed.
Make sure that you have [Node.js](https://nodejs.org/en/download/package-manager) (v22 or above) or [Deno](https://docs.deno.com/runtime/getting_started/installation/) (v2) installed.
Once you've cloned this repo, install dependencies with NPM:
Once you've cloned this repo, install dependencies with NPM:
```bash
```bash
npm install
npm install
```
```
or with Deno:
or with Deno:
```bash
```bash
deno install
deno install
```
```
then start a development server with Node:
then start a development server with Node:
```bash
```bash
npm run dev
npm run dev
```
```
or with Deno:
or with Deno:
```bash
```bash
deno task dev
deno task dev
```
```
## Building
## Building
Alexandria is configured to run on a Node server. The [Node adapter](https://svelte.dev/docs/kit/adapter-node) works on Deno as well.
Alexandria is configured to run on a Node server. The [Node adapter](https://svelte.dev/docs/kit/adapter-node) works on Deno as well.
To build a production version of your app with Node, use:
To build a production version of your app with Node, use:
```bash
```bash
npm run build
npm run build
```
```
or with Deno:
or with Deno:
```bash
```bash
deno task build
deno task build
```
```
You can preview the (non-static) production build with:
You can preview the (non-static) production build with:
```bash
```bash
npm run preview
npm run preview
```
```
or with Deno:
or with Deno:
```bash
```bash
deno task preview
deno task preview
```
```
@ -66,11 +74,13 @@ deno task preview
This docker container performs the build.
This docker container performs the build.
To build the container:
To build the container:
```bash
```bash
docker build . -t gc-alexandria
docker build . -t gc-alexandria
```
```
To run the container, in detached mode (-d):
To run the container, in detached mode (-d):
```bash
```bash
docker run -d --rm --name=gc-alexandria -p 4174:80 gc-alexandria
docker run -d --rm --name=gc-alexandria -p 4174:80 gc-alexandria
```
```
@ -83,7 +93,7 @@ If you want to see the container process (assuming it's the last process to star
docker ps -l
docker ps -l
```
```
which should return something like:
which should return something like:
```bash
```bash
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
@ -92,32 +102,36 @@ CONTAINER ID IMAGE COMMAND CREATED STATUS
## Docker + Deno
## Docker + Deno
This application is configured to use the Deno runtime. A Docker container is provided to handle builds and deployments.
This application is configured to use the Deno runtime. A Docker container is provided to handle builds and deployments.
*These tests are under development, but will run. They will later be added to the container.*
_These tests are under development, but will run. They will later be added to the container._
To run the Vitest suite we've built, install the program locally and run the tests.
To run the Vitest suite we've built, install the program locally and run the tests.
```bash
```bash
npm run test
npm run test
```
```
For the Playwright end-to-end (e2e) tests:
For the Playwright end-to-end (e2e) tests:
```bash
```bash
npx playwright test
npx playwright test
```
```
## Markup Support
## Markup Support
Alexandria supports both Markdown and AsciiDoc markup for different content types. For a detailed list of supported tags and features in the basic and advanced markdown parsers, as well as information about AsciiDoc usage for publications and wikis, see [MarkupInfo.md](./src/lib/utils/markup/MarkupInfo.md).
Alexandria supports both Markdown and AsciiDoc markup for different content types. For a detailed list of supported tags and features in the basic and advanced markdown parsers, as well as information about AsciiDoc usage for publications and wikis, see [MarkupInfo.md](./src/lib/utils/markup/MarkupInfo.md).
We are easiest to contact over our Nostr address {@renderuserBadge("npub1s3ht77dq4zqnya8vjun5jp3p44pr794ru36d0ltxu65chljw8xjqd975wz","GitCitadel")}. Or, you can visit us on our <A
We are easiest to contact over our Nostr address {@renderuserBadge(
Make sure that you follow us on <Ahref="https://github.com/ShadowySupercode/gitcitadel"target="_blank">GitHub</A> and <Ahref="https://geyser.fund/project/gitcitadel"target="_blank">Geyserfund</A>.
> and <Ahref="https://geyser.fund/project/gitcitadel"target="_blank"
>Geyserfund</A
>.
</P>
</P>
<Pclass="mb-3">
<Pclass="mb-3">
You can contact us on Nostr {@renderuserBadge("npub1s3ht77dq4zqnya8vjun5jp3p44pr794ru36d0ltxu65chljw8xjqd975wz","GitCitadel")} or you can view submitted issues on the <Ahref="https://gitcitadel.com/r/naddr1qvzqqqrhnypzquqjyy5zww7uq7hehemjt7juf0q0c9rgv6lv8r2yxcxuf0rvcx9eqy88wumn8ghj7mn0wvhxcmmv9uq3wamnwvaz7tmjv4kxz7fwdehhxarj9e3xzmny9uqsuamnwvaz7tmwdaejumr0dshsqzjpd3jhsctwv3exjcgtpg0n0/issues"target="_blank">Alexandria repo page.</A>
<Headingtag='h2'class='h-leather mt-4 mb-2'>Submit an issue</Heading>
<Headingtag="h2"class="h-leather mt-4 mb-2">Submit an issue</Heading>
<Pclass="mb-3">
<Pclass="mb-3">
If you are logged into the Alexandria web application (using the button at the top-right of the window), then you can use the form, below, to submit an issue, that will appear on our repo page.
If you are logged into the Alexandria web application (using the button at
the top-right of the window), then you can use the form, below, to submit
It is _only_ a test, for __sure__. I just wanted to see if the markup renders correctly on the page, even if I use **two asterisks** for bold text, instead of *one asterisk*.[^1]
It is _only_ a test, for **sure**. I just wanted to see if the markup renders correctly on the page, even if I use **two asterisks** for bold text, instead of _one asterisk_.[^1]
# H1
# H1
## H2
## H2
### H3
### H3
#### H4
#### H4
##### H5
##### H5
###### H6
###### H6
This file is full of ~errors~ opportunities to ~~mess up the formatting~~ check your markup parser.
This file is full of ~errors~ opportunities to ~~mess up the formatting~~ check your markup parser.
@ -24,51 +28,49 @@ npub1l5sga6xg72phsz5422ykujprejwud075ggrr3z2hwyrfgr7eylqstegx9z wrote this. That
> lines of
> lines of
> important information
> important information
> with a second[^2] footnote.
> with a second[^2] footnote.
[^2]: This is a "Test" of a longer footnote-reference, placed inline, including some punctuation. 1984.
> [^2]: This is a "Test" of a longer footnote-reference, placed inline, including some punctuation. 1984.
2. third 4. fourth indented 5. fifth indented even more 6. sixth under the fourth 7. seventh under the sixth
4. fourth indented
3. eighth under the third
5. fifth indented even more
6. sixth under the fourth
7. seventh under the sixth
8. eighth under the third
This is ordered and unordered mixed:
This is ordered and unordered mixed:
1. first
2. second indented
1. first 2. second indented
3. third
2. third
* make this a bullet point
- make this a bullet point 4. fourth indented even more
4. fourth indented even more
- second bullet point
* second bullet point
Here is a horizontal rule:
Here is a horizontal rule:
@ -130,13 +132,31 @@ in a code block
You can even use a multi-line code block, with a json tag.
You can even use a multi-line code block, with a json tag.
```json
````json
{
{
"created_at":1745038670,"content":"# This is a test\n\nIt is _only_ a test. I just wanted to see if the *markup* renders correctly on the page, even if I use **two asterisks** for bold text.[^1]\n\nnpub1l5sga6xg72phsz5422ykujprejwud075ggrr3z2hwyrfgr7eylqstegx9z wrote this. That's the same person as nostr:npub1l5sga6xg72phsz5422ykujprejwud075ggrr3z2hwyrfgr7eylqstegx9z. That is a different person from npub1s3ht77dq4zqnya8vjun5jp3p44pr794ru36d0ltxu65chljw8xjqd975wz.\n\n> This is important information\n\n> This is multiple\n> lines of\n> important information\n> with a second[^2] footnote.\n\n* but\n* not\n* really\n\n## More testing\n\n1. first\n2. second\n3. third\n\nHere is a horizontal rule:\n\n---\n\nThis is an implementation of [Nostr-flavored markup](github.com/nostrability/nostrability/issues/146 ) for #gitstuff issue notes.\n\nYou can even include `code inline` or\n\n```\nin a code block\n```\n\nYou can even use a \n\n```json\nmultiline of json block\n```\n\n\n\n\n[^1]: this is a footnote\n[^2]: so is this","tags":[["subject","test"],["alt","git repository issue: test"],["a","30617:fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1:Alexandria","","root"],["p","fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1"],["t","gitstuff"]],"kind":1621,"pubkey":"dd664d5e4016433a8cd69f005ae1480804351789b59de5af06276de65633d319","id":"e78a689369511fdb3c36b990380c2d8db2b5e62f13f6b836e93ef5a09611afe8","sig":"7a2b3a6f6f61b6ea04de1fe873e46d40f2a220f02cdae004342430aa1df67647a9589459382f22576c651b3d09811546bbd79564cf472deaff032f137e94a865"
"created_at": 1745038670,
"content": "# This is a test\n\nIt is _only_ a test. I just wanted to see if the *markup* renders correctly on the page, even if I use **two asterisks** for bold text.[^1]\n\nnpub1l5sga6xg72phsz5422ykujprejwud075ggrr3z2hwyrfgr7eylqstegx9z wrote this. That's the same person as nostr:npub1l5sga6xg72phsz5422ykujprejwud075ggrr3z2hwyrfgr7eylqstegx9z. That is a different person from npub1s3ht77dq4zqnya8vjun5jp3p44pr794ru36d0ltxu65chljw8xjqd975wz.\n\n> This is important information\n\n> This is multiple\n> lines of\n> important information\n> with a second[^2] footnote.\n\n* but\n* not\n* really\n\n## More testing\n\n1. first\n2. second\n3. third\n\nHere is a horizontal rule:\n\n---\n\nThis is an implementation of [Nostr-flavored markup](github.com/nostrability/nostrability/issues/146 ) for #gitstuff issue notes.\n\nYou can even include `code inline` or\n\n```\nin a code block\n```\n\nYou can even use a \n\n```json\nmultiline of json block\n```\n\n\n\n\n[^1]: this is a footnote\n[^2]: so is this",
