100 |
18 | Welcome to the official astro-org blog starter template. This 19 | template serves as a lightweight, minimally-styled starting point for anyone looking to 20 | build a personal website, blog, or portfolio with Astro. 21 |
22 |
23 | This template comes with a few integrations already configured in your
24 | astro.config.mjs file. You can customize your setup with
25 | Astro Integrations to add tools like
26 | Tailwind, React, or Vue to your project.
27 |
Here are a few ideas on how to get started with the template:
29 |src/pages/index.astrosrc/components/Header.astrosrc/components/Footer.astrosrc/pages/blog/src/layouts/BlogPost.astro37 | Have fun! If you get stuck, remember to read the docs 39 | or join us on Discord to ask questions. 40 |
41 |other org-mode 22 |
23 | { title: 'Post title', author: 'Your Name' } 24 | ``` 25 | -------------------------------------------------------------------------------- /examples/extract-keywords-example/example.org: -------------------------------------------------------------------------------- 1 | #+TITLE: Post title 2 | #+AUTHOR: Your Name 3 | 4 | other org-mode 5 | -------------------------------------------------------------------------------- /examples/extract-keywords-example/index.js: -------------------------------------------------------------------------------- 1 | import { unified } from 'unified'; 2 | import { readSync } from 'to-vfile'; 3 | import uniorgParse from 'uniorg-parse'; 4 | import { extractKeywords } from 'uniorg-extract-keywords'; 5 | import uniorg2rehype from 'uniorg-rehype'; 6 | import html from 'rehype-stringify'; 7 | 8 | unified() 9 | .use(uniorgParse) 10 | .use(extractKeywords) 11 | .use(uniorg2rehype) 12 | .use(html) 13 | .process(readSync('example.org'), function (err, file) { 14 | console.log(file.toString()); 15 | console.log(file.data); 16 | }); 17 | -------------------------------------------------------------------------------- /examples/extract-keywords-example/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "extract-keywords-example", 3 | "version": "1.0.6", 4 | "private": true, 5 | "type": "module", 6 | "description": "Example of using uniorg-extract-keywords", 7 | "author": "Oleksii Shmalko{excerpt}
43 |{excerpt}
39 |file:data/ea/e6a180-58d3-44b9-9c95-d8924849d365/file.txt 47 |
48 | ``` 49 | 50 | ## Options 51 | 52 | ### `idDir` 53 | 54 | Type: `string?` 55 | 56 | Default: `"data/"` 57 | 58 | The directory where attachments are stored. If this is a relative path, it will be interpreted relative to the directory where the Org file lives. 59 | 60 | Corresponds to `org-attach-id-dir` in Emacs. 61 | 62 | ### `useInheritance` 63 | 64 | Type: `boolean?` 65 | 66 | Default: `false` 67 | 68 | > **NOTE:** In Emacs, the default is `'selective` which means that Emacs will look at `org-use-property-inheritance` to check whether `ID` and `DIR` properties are inherited. uniorg-attach does not currently do that. This shouldn’t cause any troubles unless you inherit one property but not the other. 69 | 70 | Attachment inheritance for the outline. 71 | 72 | Enabling inheritance for implies that attachment links will look through all parent headings until it finds the linked attachment. 73 | 74 | Corresponds to `org-attach-use-inheritance` in Emacs. 75 | 76 | ### `idToPath` 77 | 78 | Type: `(id: string) => string` 79 | 80 | Default: `idUuidFolderFormat` 81 | 82 | A function parsing an ID string into a folder-path. 83 | 84 | Similar to `org-attach-id-to-path-function-list` in Emacs, but only allows one function. 85 | 86 | This module exports `idUuidFolderFormat` and `idTsFolderFormat` that re-implement two common behaviors for org-attach. 87 | 88 | ## License 89 | 90 | [GNU General Public License v3.0 or later](./LICENSE) 91 | -------------------------------------------------------------------------------- /packages/uniorg-attach/jest.config.js: -------------------------------------------------------------------------------- 1 | import config from '../../jest-base.mjs'; 2 | export default { ...config }; 3 | -------------------------------------------------------------------------------- /packages/uniorg-attach/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "uniorg-attach", 3 | "version": "1.1.0", 4 | "type": "module", 5 | "description": "Uniorg plugin to process org-attach attachment links", 6 | "keywords": [ 7 | "uniorg", 8 | "unified", 9 | "plugin", 10 | "org-mode", 11 | "attach", 12 | "org-attach" 13 | ], 14 | "author": "Oleksii Shmalkoother org-mode 47 |
48 | 49 | { title: 'Post title', author: 'Your Name' } 50 | ``` 51 | 52 | **Note: you should use to-vfile@6. to-vfile@7 is currently incompatible with unified@9. See [#12](https://github.com/rasendubi/uniorg/issues/12#issuecomment-850945694) for more details.** 53 | 54 | ## Options 55 | 56 | ### name 57 | 58 | Type: `string?` 59 | 60 | Default: `undefined` 61 | 62 | Specify a key to store keywords under. For example, `{ name: 'keywords' }` will store all keyword values as `{ data: { keywords: { ... } } }`. By default, all keywords are merged into the `data` object. 63 | 64 | Example: 65 | 66 | ```js 67 | unified() 68 | .use(uniorgParse) 69 | .use(extractKeywords, { name: 'keywords' }) 70 | .use(uniorg2rehype) 71 | .use(html) 72 | .process('#+TITLE: Example', function (err, file) { 73 | console.log(file.data); 74 | }); 75 | ``` 76 | 77 | will output 78 | 79 | ``` 80 | { keywords: { title: 'Example' } } 81 | ``` 82 | 83 | ### preserveCase 84 | 85 | Type: `boolean` 86 | 87 | Default: `false` 88 | 89 | Whether to preserve case of the keywords. By default, all keywords are converted to lowercase. 90 | 91 | Example: 92 | 93 | ```js 94 | unified() 95 | .use(uniorgParse) 96 | .use(extractKeywords, { preserveCase: true }) 97 | .use(uniorg2rehype) 98 | .use(html) 99 | .process('#+TITLE: Example', function (err, file) { 100 | console.log(file.data); 101 | }); 102 | ``` 103 | 104 | will output 105 | 106 | ``` 107 | { TITLE: 'Example' } 108 | ``` 109 | 110 | ## License 111 | 112 | [GNU General Public License v3.0 or later](./LICENSE) 113 | -------------------------------------------------------------------------------- /packages/uniorg-extract-keywords/jest.config.js: -------------------------------------------------------------------------------- 1 | import config from '../../jest-base.mjs'; 2 | export default { ...config }; 3 | -------------------------------------------------------------------------------- /packages/uniorg-extract-keywords/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "uniorg-extract-keywords", 3 | "version": "1.1.0", 4 | "type": "module", 5 | "description": "Store org keywords and their values in vfile data property", 6 | "keywords": [ 7 | "uniorg", 8 | "unified", 9 | "plugin", 10 | "org-mode" 11 | ], 12 | "author": "Oleksii Shmalkoid property is ignored.
id property is ignored.