diff --git a/README.md b/README.md index a3266cd..3248ab3 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,15 @@ # Alexandria -Alexandria is a reader and writer for curated publications. -For a thorough introduction, please refer to our [project documention](https://next-alexandria.gitcitadel.eu/publication?d=gitcitadel-project-documentation-by-stella-v-1), viewable on Alexandria. +Alexandria is a reader and writer for curated publications, including e-books. +For a thorough introduction, please refer to our [project documention](https://next-alexandria.gitcitadel.eu/publication?d=gitcitadel-project-documentation-by-stella-v-1), viewable on Alexandria, or to the Alexandria [About page](https://next-alexandria.gitcitadel.eu/about). ## Issues and Patches If you would like to suggest a feature or report a bug, or submit a patch for review, please use the [Nostr git interface](https://gitcitadel.com/r/naddr1qvzqqqrhnypzplfq3m5v3u5r0q9f255fdeyz8nyac6lagssx8zy4wugxjs8ajf7pqyt8wumn8ghj7ur4wfcxcetjv4kxz7fwvdhk6tcqpfqkcetcv9hxgunfvyamcf5z) on our homepage. +You can also contact us [on Nostr](https://njump.me/nprofile1qqsggm4l0xs23qfjwnkfwf6fqcs66s3lz637gaxhl4nwd2vtle8rnfqprfmhxue69uhhg6r9vehhyetnwshxummnw3erztnrdaks5zhueg), directly. + ## Developing 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. diff --git a/src/app.css b/src/app.css index 61f876c..79fee31 100644 --- a/src/app.css +++ b/src/app.css @@ -28,6 +28,11 @@ @apply hover:text-primary-400 dark:hover:text-primary-500 hover:border-primary-400 dark:hover:border-primary-500 hover:bg-gray-200 dark:hover:bg-gray-700; } + /* Images */ + .image-border { + @apply border border-primary-700; + } + /* Card */ div.card-leather { @apply shadow-none text-primary-1000 border-s-4 bg-highlight border-primary-200 has-[:hover]:border-primary-700; diff --git a/src/lib/components/EditorArticle.svelte b/src/lib/components/EditorArticle.svelte deleted file mode 100644 index 51c951e..0000000 --- a/src/lib/components/EditorArticle.svelte +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/src/lib/components/LinkToArticle.svelte b/src/lib/components/LinkToArticle.svelte deleted file mode 100644 index 9d705a7..0000000 --- a/src/lib/components/LinkToArticle.svelte +++ /dev/null @@ -1,8 +0,0 @@ - - - diff --git a/src/lib/components/Navigation.svelte b/src/lib/components/Navigation.svelte index d0cd37c..2ac6133 100644 --- a/src/lib/components/Navigation.svelte +++ b/src/lib/components/Navigation.svelte @@ -18,7 +18,7 @@ - New Note + Publish Visualize About diff --git a/src/lib/components/Preview.svelte b/src/lib/components/Preview.svelte index ec3a496..f7dfe03 100644 --- a/src/lib/components/Preview.svelte +++ b/src/lib/components/Preview.svelte @@ -178,7 +178,7 @@ {/snippet} {#snippet contentParagraph(content: string, publicationType: string)} - {#if publicationType === 'book'} + {#if publicationType === 'novel'}

{@html content}

diff --git a/src/lib/components/Article.svelte b/src/lib/components/Publication.svelte similarity index 100% rename from src/lib/components/Article.svelte rename to src/lib/components/Publication.svelte diff --git a/src/lib/components/PublicationFeed.svelte b/src/lib/components/PublicationFeed.svelte index 389e3cd..a6c28e8 100644 --- a/src/lib/components/PublicationFeed.svelte +++ b/src/lib/components/PublicationFeed.svelte @@ -4,7 +4,7 @@ import { filterValidIndexEvents } from '$lib/utils'; import { NDKRelaySet, type NDKEvent } from '@nostr-dev-kit/ndk'; import { Button, P, Skeleton, Spinner } from 'flowbite-svelte'; - import ArticleHeader from './ArticleHeader.svelte'; + import ArticleHeader from './PublicationHeader.svelte'; import { onMount } from 'svelte'; let { relays } = $props<{ relays: string[] }>(); @@ -90,7 +90,7 @@ {/each} {:else} -

No articles found.

+

No publications found.

{/if} {#if !loadingMore && !endOfFeed}
diff --git a/src/lib/components/ArticleHeader.svelte b/src/lib/components/PublicationHeader.svelte similarity index 100% rename from src/lib/components/ArticleHeader.svelte rename to src/lib/components/PublicationHeader.svelte diff --git a/src/routes/+page.svelte b/src/routes/+page.svelte index 5dd0ea0..1b204f1 100644 --- a/src/routes/+page.svelte +++ b/src/routes/+page.svelte @@ -28,7 +28,7 @@ {:else}
  • diff --git a/src/routes/about/+page.svelte b/src/routes/about/+page.svelte index 611bd2b..b16db6d 100644 --- a/src/routes/about/+page.svelte +++ b/src/routes/about/+page.svelte @@ -1,15 +1,56 @@
    About -

    Alexandria is an editor and generator for curated publications and will soon also be a reader for long-form articles and wiki pages. - It is produced by the GitCitadel project team.

    +

    Alexandria is a reader and writer for curated publications (in Asciidoc), and will eventually also support long-form articles (Markdown) and wiki pages (Asciidoc). It is produced by the GitCitadel project team.

    Please submit support issues on the project repo page and follow us on GitHub and Geyserfund.

    + +

    We are easiest to contact over our Nostr address npub1s3ht77dq4zqnya8vjun5jp3p44pr794ru36d0ltxu65chljw8xjqd975wz.

    + + Overview + +

    Alexandria opens up to the landing page, where the user can: login (top-right), select whether to only view the publications hosted on the thecitadel document relay or add in their own relays, and scroll/search the publications.

    + +

    Landing page

    +

    Relay selection

    + +

    There is also the ability to view the publications as a diagram, if you click on "Visualize", and to publish an e-book or other document (coming soon).

    + +

    If you click on a card, which represents a 30040 index event, the associated reading view opens to the publication. The app then pulls all of the content events (30041s), in the order in which they are indexed, and displays them as a single document.

    + +

    Each 30041 section is also a level in the table of contents, which can be accessed from the floating icon top-left in the reading view. This allows for navigation within the publication. (This functionality has been temporarily disabled.)

    + +

    ToC icon

    +

    Table of contents example

    + + Typical use cases + + For e-books +

    The most common use for Alexandria is for e-books: both those users have written themselves and those uploaded to Nostr from other sources. The first minor version of the app, Gutenberg, is focused on displaying and producing these publications.

    + +

    An example of a book is Jane Eyre

    + +

    Jane Eyre, by Charlotte Brontë

    + + For scientific papers +

    Alexandria will also display research papers with Asciimath and LaTeX embedding, and the normal advanced formatting options available for Asciidoc. In addition, we will be implementing special citation events, which will serve as an alternative or addition to the normal footnotes.

    + +

    Correctly displaying such papers, integrating citations, and allowing them to be reviewed (with kind 1111 comments), and annotated (with highlights) by users, is the focus of the second minor version, Euler.

    + +

    Euler will also pioneer the HTTP-based (rather than websocket-based) e-paper compatible version of the web app.

    + +

    An example of a research paper is Less Partnering, Less Children, or Both?

    + +

    Research paper

    + + For documentation +

    Our own team uses Alexandria to document the app, to display our blog entries, as well as to store copies of our most interesting technical specifications.

    + +

    Documentation

    +
    \ No newline at end of file diff --git a/src/routes/publication/+page.svelte b/src/routes/publication/+page.svelte index 1a13cff..dbd673f 100644 --- a/src/routes/publication/+page.svelte +++ b/src/routes/publication/+page.svelte @@ -1,5 +1,5 @@