Guide: Obsidian plug-in for exporting notes to Strapi

Obsidian Plugin for exporting a note to Strapi

• An item you want to publish, written in your Obsidian Vault
• An API online, and available.
• Remote access from the Internet to your API possible (local access won't work!).
• An OpenAI key.

Tuto

Download main.js & manifest.js, the latest version available.

Then go to the root of our Obsidian (for me it's C:\Users\andyq\Obsidian)

Then we open our Vault Obsidian and go through the parameters.

Configuration

Strapi API Token

We'll start with the Strapi token.

Go to the Strapi API. In settings, API Token, and create a token

Simple

Full access, so you don't have to worry about rights.

Advanced (optional)

With the rights strictly necessary to create an article, it is also necessary to have image upload rights.

We take the generated Obsidian token, and put it in our config:

Open AI Settings

Create our secret here,

Set our key here

Additional prompt

If present, the locale needs to be 'fr' and the content in French, and generate at least 8 tags if present in the schema too. If present, the rank needs to be 999. Meta Description: Write an attractive meta description including the main keyword, which encourages clicking on the article from the search results. Optimization for Readers and Search Engines: Write content that is not only optimized for search engines but also engaging and informative for readers. The content must answer their questions or solve a problem.

Strapi settings - call 1

Strapi URL ( call 1 )

We're now going to configure the first call (the one that will create our articles, for example).

To do this, go to documentation, then Open Documentation

We retrieve the general URL of our Strapi, which for me is:

And we replace the local address displayed by the remote address, which for me is: https://api.andy-cinquin.fr

Json template config

And we retrieve from our swagger on the Strapi side, the data schema we need to send. We delete the links to other cascading tables (sorry! it's not yet implemented!) And we delete the "content" part (the part that will correspond to the main content of your article / realization ), as well as the images for the moment.

{ "data": { "title": "string", "seo_title": "string", "seo_description": "string", "slug": "string", "excerpt": "string", "links": [ { "id": "number", "label": "string", "url": "string" } ], "subtitle": "string", "type": "string", "rank": "number", "tags": [ { "id": "number", "name": "string" } ], "locale": "string" } }

Json template config description

{ "data": { "title": "Title of the item, as a short string", "seo_title": "SEO optimized title, as a short string", "seo_description": "SEO optimized description, as a short string", "slug": "URL-friendly string derived from the title", "excerpt": "A short preview or snippet from the content", "links": "Array of related links with ID, label, and URL", "subtitle": "Subtitle or secondary title, as a short string", "type": "Category or type of the item, as a short string", "rank": "Numerical ranking or order priority, as a number", "tags": "Array of associated tags with ID and name", "locale": "Locale or language code, as a short string" } }

Strapi create url

This is the complete url to the creation of an article or realization, for me it's https://api.andy-cinquin.fr/api/articles

Strapi content attribute name call

For me, the main content of my article is found here, I just indicate the name of this field here (I do this to save tokens in API calls to OpenAI!).

Optional (image)

If you have an image, for example a background, or an illustration to add to your API at the same time, and you want to do everything at once, this is a good method.

To be able to use it, you need to have a folder in your Obsidian called "image"

The architecture should look like this to be able to use a single image

Optional (gallery)

Same system as for images, but with "gallery".

Configuration call 2 ( optional )

Using the application

Once all this is configured, simply click on the little upload icon on the left of the sidebar to upload the article itself.