Skip to content

Commit

Permalink
icon and docs v1
Browse files Browse the repository at this point in the history
  • Loading branch information
dmca-glasgow committed Aug 21, 2024
1 parent c31ad70 commit 445861d
Show file tree
Hide file tree
Showing 22 changed files with 37 additions and 5 deletions.
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,39 @@
# Tauri + Preact + Typescript
# ISOS

This template should help get you started developing with Tauri, Preact and Typescript in Vite.
> _Ancient Greek "ἴσως" for equally, fairly, equitably._
## Recommended IDE Setup
> _It could also expand to **Inclusive Study of STEM**._
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
## Introduction

This program aims to produce accessible HTML documents from LaTeX and Markdown documents. Upon opening a `.tex` or `.md` file with the program, it will display preview of the resulting HTML file. It will also watch the file so each time it's saved the preview will refresh, which should facilitate speedy amendments. When you're ready, you can save the HTML file.

Converting LaTeX to HTML isn't always straightforward, because the two technologies are fundamentally different. This project doesn't aim to provide a seamless conversion of all LaTeX to HTML. Instead, it hopes to support a subset of LaTeX commands and packages (TBD).

## Installation

- [ISOS installer for Mac (Apple Silicon)](#)
- [ISOS installer for Mac (Intel)](#)
- [ISOS installer for Windows](#)
- [ISOS installer for Linux (cross-distribution AppImage)](#)

## Quickstart Guide for LaTeX users

### Headings

In HTML, there is the concept of 6 heading ranks, represented as `<h1>` to `<h6>`. In accessible HTML guidelines, it's usually recommended that there be only one `<h1>` in a document, and to avoid skipping heading ranks (for example, make sure that an `<h2>` is not followed directly by an `<h4>`).

In the HTML file produced by ISOS, there is a table of contents in the sidebar to help users easily navigate around large documents. This table of contents is generated from the `<h2>`'s and `<h3>`'s in the document.

You many need to adjust your LaTeX section titles in order for this table of contents to render correctly.

Here is how ISOS maps LaTeX sections and HTML headings:

| HTML | LaTeX |
| ---- | -------------- |
| h1 | \title |
| h2 | \section |
| h3 | \subsection |
| h4 | \subsubsection |
| h5 | \paragraph |
| h6 | \subparagraph |
Binary file added design/docs-site.psd
Binary file not shown.
Binary file added design/icon-macos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added design/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added design/icon.psd
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/src/app.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#app {
width: 400px;
width: 450px;
margin: 0 auto;
padding: 2rem;
text-align: center;
Expand Down
Binary file modified src-tauri/icons/128x128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square107x107Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square142x142Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square150x150Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square284x284Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square30x30Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square310x310Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square44x44Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square71x71Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/Square89x89Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/StoreLogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src-tauri/icons/icon.icns
Binary file not shown.
Binary file modified src-tauri/icons/icon.ico
Binary file not shown.
Binary file modified src-tauri/icons/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 445861d

Please sign in to comment.