Comments (3)
The markdown guide explains this (see Customizing a plugin. I did notice the reference is presented first in the search results, which I'm guessing is what lead you to reference? We could 100% look at adding a plugin with options or a link to the example.
from docs.
The markdown guide explains this (see Customizing a plugin. I did notice the reference is presented first in the search results, which I'm guessing is what lead you to reference? We could 100% look at adding a plugin with options or a link to the example.
Yes, I ended up in the reference via search. An example plugin with options or a link to the existing example will make things a lot easier.
from docs.
Interestingly when I searched, I did not get reference first but did get the upgrade guides first, then the Learn, and then reference!
What if we just update the example on the configuration reference page, which currently shows remarkToc
anyway, and just add any old custom value, e.g. the one on the Markdown page:
remarkPlugins: [ [remarkToc, { heading: "contents"} ] ],
We try to keep the configuration page as concise as possible, but this at least is a visual clue to point people in the right direction without needing a ton of words to clutter the page.
Would be happy if someone would like to make a PR to that effect! The change to make would be on this line
from docs.
Related Issues (20)
- Zod compatibility HOT 3
- Document View Transition events fields HOT 7
- Abount Fontsource package name HOT 2
- View Transitions Script Behavior HOT 1
- Double/triple click headings copy issues HOT 2
- Getting errors creating a new project
- Clarify how to implement social image URLs HOT 4
- Missing explanation about "themes" from ShikiConfig in syntax highlighting HOT 2
- ⚠️ Issue - The implementation of themes from Shiki is not working properly. HOT 1
- Add a bit more help text to client:only description
- Give us feedback form Appearance is not in line with Astro Doc Styling HOT 1
- RTL Docs `Inline Code Snippet` need to be always LTR.
- Deploying to GitHub Pages is problematic/flakey HOT 1
- Prettier plugin content is incorrect. HOT 1
- Middleware: unclear that reading cookies/headers behaviour
- Improve documentation on fallback content for slots HOT 2
- Unclear refactoring task
- Script Tag CDNs with View Transitions
- `prose-p:text-justify` makes recipe less usable
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.