website logo
Sign Up ➑Book a Demo
🌐Help Center
πŸ’ΌJobs
Navigate through spaces
⌘K
πŸ‘‹Archbee Documentation Portal
πŸš€GETTING STARTED
Learn the basics
How to get started
Use cases
πŸ“EDITOR
πŸ“ƒDOCUMENTS
πŸ—ƒοΈSPACES
🌎HOSTED SPACES
β˜•ORGANIZATIONS
πŸ“¦IMPORT & EXPORT
πŸ”ŒINTEGRATIONS
πŸ“₯GUIDES
πŸ”ƒPUBLIC API
Doc
➿MISC
πŸ™‹Q&A
How can i arrange and group my imported OpenAPI docs
Why the landing page template isn't publishing to production
Why I can't remove Archbee branding on Startup plan
Why is my published space blank?
Why can't i change the domain?
Docs powered byΒ archbeeΒ 

Code snippets

4min

This feature is available on these plans: βœ”οΈ Growing βœ”οΈ Scaling βœ”οΈ Enterprise

You can add code snippets in your GitHub repo, by configuring them in the config.md file. The config.md file should be in the same folder as summary.md Below is an example of a config.md file:

config.md
Text
Curl
|

ο»Ώ

Example

Assuming that you have the bellow package.json file(from the above example)ο»Ώ

Document image
ο»Ώ

And you have the below config.md:

config.md
|
## specify syntax, from and to parameters explicitly
::use{file="swagger-v2.json" from="L6" to="L10" syntax="javascript"}

ο»Ώ

After you import, you will see this in the Archbee doc:

JS
|
"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "runall": "mocha -u tdd ./*test.js",
    "start": "src/main.js"
},
ο»Ώ

ο»Ώ

Updated 24 Feb 2023
Did this page help you?
Yes
No
PREVIOUS
Custom code
NEXT
Adding multiple repositories
Docs powered byΒ archbeeΒ 
TABLE OF CONTENTS
Example