use font directories in cli, update docs

Author: noamzaks

Cargo.lock

@@ -0,0 +1,35 @@
+# Configuration
+
+## Configuration Directory
+
+TyX's configuration directory follows [Tauri's app configuration directory](https://v2.tauri.app/reference/javascript/api/namespacepath/#appconfigdir).
+
+This resolves to the following directories:
+
+- Linux: `$XDG_CONFIG_HOME/com.tyx-editor.tyx` or `$HOME/.config/com.tyx-editor.tyx`
+- macOS: `$HOME/Library/Application Support/com.tyx-editor.tyx`
+- Windows: `{FOLDERID_RoamingAppData}\com.tyx-editor.tyx`
+
+## Settings
+
+The settings file is called `settings.json` and it follows the [TyX settings schema](https://tyx-editor.com/schemas/tyx-settings.schema.json).
+
+It can be edited in the UI by pressing the default `mod+;` keyboard shortcut or opening settings in the splash screen.
+
+This includes the UI language, your keyboard shortcuts, your math inline shortcuts, and optionally your keyboard map.
+
+!!! tip
+
+    You can also create this settings file and then TyX will automatically read and use it!
+
+## Fonts
+
+You can place fonts for use in your TyX documents in a `fonts` directory inside your TyX configuration directory.
+
+TyX automatically adds this to the font paths for documents you compile with it.
+
+## Templates
+
+You can place templates for your TyX documents in a `templates` directory inside your TyX configuration directory.
+
+TyX automatically suggests files from this directory when pressing the "New From Template" option in the splash screen or pressing its default `mod+shift+n` shortcut.

docs/configuration.md

@@ -5,3 +5,12 @@
 To install TyX, you can go to [tyx-editor.com](https://tyx-editor.com).
 
 Alternatively, you can download the installer for your operating system from the [GitHub releases](https://github.com/tyx-editor/TyX/releases).
+
+## Using TyX
+
+TyX is intended for two types of users:
+
+- Users who simply wish to easily edit documents and have them look good, without diving too deep.
+- Power users who hack TyX and create nice configurations (for their language, institution, etc.).
+
+For power users, it is recommended to read the [Configuration](./configuration.md) section for the various ways to create setups for TyX.

docs/document-settings.md

@@ -11,6 +11,8 @@ It is designed to create an easy-to-use, WYSIWYM interface inspired by LyX.
     Keep this in mind!
     **Contributions are encouraged and welcomed!**
 
+For installation and more details using TyX, see the [Getting Started](./getting-started.md) section!
+
 ## Features
 
 ### Math Editor

docs/file-format.md

@@ -23,9 +23,7 @@ markdown_extensions:
 nav:
   - Introduction:
       - getting-started.md
-      - settings.md
-      - document-settings.md
+      - configuration.md
   - API Docs:
-      - file-format.md
       - commands.md
       - CHANGELOG.md

docs/getting-started.md

@@ -31,6 +31,7 @@ typst-pdf.workspace = true
 tyx-schema.workspace = true
 tyx-converters.workspace = true
 tyx-version.workspace = true
+directories = "6.0.0"
 typstyle-core = "0.13.14"
 url = "2.5.4"
 open = "5"

docs/index.md

@@ -0,0 +1,78 @@
+use std::path::{Path, PathBuf};
+
+use crate::pdf::typst_to_pdf;
+use clap::{Parser, ValueEnum};
+
+#[derive(Debug, Clone, ValueEnum)]
+pub(crate) enum ExportFormat {
+    Typst,
+    Pdf,
+}
+
+impl ExportFormat {
+    pub(crate) fn extension(&self) -> &str {
+        match self {
+            Self::Pdf => ".pdf",
+            Self::Typst => ".typ",
+        }
+    }
+
+    pub(crate) fn export(&self, input: String, filename: &str) -> Vec<u8> {
+        let dirname = Path::new(filename).parent().unwrap().to_str().unwrap();
+
+        match self {
+            Self::Typst => tyx_converters::serialized_tyx_to_typst(&input).into_bytes(),
+            Self::Pdf => {
+                let contents = tyx_converters::serialized_tyx_to_typst(&input);
+                typst_to_pdf(filename, &contents, PathBuf::from(dirname), vec![]).unwrap()
+            }
+        }
+    }
+}
+
+/// Simple program to greet a person
+#[derive(Parser, Debug)]
+#[command(version = tyx_version::VERSION, about, long_about = None, display_name="TyX")]
+pub(crate) struct Args {
+    /// Files to open or export.
+    pub(crate) files: Vec<String>,
+    /// Export as this file format, the default output filenames are just replacing the file extension
+    #[arg(short, long)]
+    pub(crate) export: Option<ExportFormat>,
+    /// Save the output to this filename, requires files to be only one.
+    #[arg(short, long)]
+    pub(crate) output: Option<String>,
+}
+
+impl Args {
+    pub(crate) fn process(&self) -> bool {
+        let mut should_exit = false;
+
+        let output_filename = match &self.output {
+            Some(output) => {
+                assert!(self.files.len() == 1);
+                Some(output)
+            }
+            None => None,
+        };
+        for file in self.files.iter() {
+            let contents = std::fs::read_to_string(file).unwrap();
+            if let Some(ref format) = self.export {
+                let file_base = match file.strip_suffix(".tyx") {
+                    Some(file) => file,
+                    None => {
+                        println!("warning: file {file} might not be a TyX document!");
+                        file
+                    }
+                };
+                should_exit = true;
+                let default_filename = String::from(file_base) + format.extension();
+                let final_output_filename = output_filename.unwrap_or(&default_filename);
+                println!("Exported to {final_output_filename}");
+                std::fs::write(final_output_filename, format.export(contents, file)).unwrap();
+            }
+        }
+
+        should_exit
+    }
+}