Merge pull request #4 from JaneliaSciComp/updates_external_links

updates external links

Author: allison-truhlar

astro.config.mjs

@@ -1,11 +1,22 @@
 // @ts-check
 import { defineConfig } from 'astro/config';
 import starlight from '@astrojs/starlight';
+import rehypeExternalLinks from 'rehype-external-links';
+import { externalLinkIcon } from './external-link-icon.js';
 
 // https://astro.build/config
 export default defineConfig({
 	site: 'https://JaneliaSciComp.github.io',
 	base: '/fileglancer-user-docs',
+	markdown: {
+		rehypePlugins: [
+			[rehypeExternalLinks, {
+				target: '_blank',
+				rel: ['noopener', 'noreferrer'],
+				content: externalLinkIcon
+			}]
+		]
+	},
 	integrations: [
 		starlight({
 			title: 'Fileglancer User Guide',

external-link-icon.js

@@ -0,0 +1,36 @@
+/**
+ * External link icon for rehype-external-links plugin.
+ *
+ * This SVG is defined using the hast (Hypertext Abstract Syntax Tree) format,
+ * which is the AST format used by rehype plugins. The rehype-external-links
+ * plugin expects content to be provided as a hast node, not as raw HTML/SVG markup.
+ *
+ * The icon uses Starlight's built-in "external" icon design.
+ */
+export const externalLinkIcon = {
+	type: 'element',
+	tagName: 'svg',
+	properties: {
+		width: '1em',
+		height: '1em',
+		viewBox: '0 0 24 24',
+		fill: 'currentColor',
+		style: 'display: inline-block; vertical-align: text-bottom; margin-left: 0.25em;'
+	},
+	children: [
+		{
+			type: 'element',
+			tagName: 'path',
+			properties: {
+				d: 'M19.33 10.18a1 1 0 0 1-.77 0 1 1 0 0 1-.62-.93l.01-1.83-8.2 8.2a1 1 0 0 1-1.41-1.42l8.2-8.2H14.7a1 1 0 0 1 0-2h4.25a1 1 0 0 1 1 1v4.25a1 1 0 0 1-.62.93Z'
+			}
+		},
+		{
+			type: 'element',
+			tagName: 'path',
+			properties: {
+				d: 'M11 4a1 1 0 1 1 0 2H7a1 1 0 0 0-1 1v10a1 1 0 0 0 1 1h10a1 1 0 0 0 1-1v-4a1 1 0 1 1 2 0v4a3 3 0 0 1-3 3H7a3 3 0 0 1-3-3V7a3 3 0 0 1 3-3h4Z'
+			}
+		}
+	]
+};

package-lock.json

@@ -12,6 +12,7 @@
   "dependencies": {
     "@astrojs/starlight": "^0.36.0",
     "astro": "^5.6.1",
+    "rehype-external-links": "^3.0.0",
     "sharp": "^0.34.2"
   }
-}
+}

package.json

@@ -64,4 +64,4 @@ If you encounter issues or need assistance, chat with us in the [#fileglancer-su
 
 ## Interested in using Fileglancer outside of Janelia?
 
-We welcome interest from other institutions and are excited to collaborate on making Fileglancer more broadly accessible! While the application was initially developed for use at Janelia, we’re eager to help adapt it for different environments. If you’d like to use Fileglancer at your organization, or have ideas for improvements, we encourage you to [open an issue](https://github.com/JaneliaSciComp/fileglancer/issues) or [submit a pull request](https://github.com/JaneliaSciComp/fileglancer/pulls). Your feedback and contributions are greatly appreciated and will help to make Fileglancer even better for the scientific community!
+We welcome interest from other institutions and are excited to collaborate on making Fileglancer more broadly accessible! While the application was initially developed for use at Janelia, we're eager to help adapt it for different environments. If you'd like to use Fileglancer at your organization, or have ideas for improvements, we encourage you to [open an issue](https://github.com/JaneliaSciComp/fileglancer/issues) or [submit a pull request](https://github.com/JaneliaSciComp/fileglancer/pulls). Your feedback and contributions are greatly appreciated and will help to make Fileglancer even better for the scientific community!