mongodb-js / charts-embed-sdk

The easiest way to embed MongoDB Charts visualisations into your web app
https://docs.mongodb.com/charts/master/embedding-charts-sdk/
Apache License 2.0
43 stars 31 forks source link

docs: CHARTS-6059 Extract common text from SDK guides #81

Open lilyh4 opened 1 year ago

lilyh4 commented 1 year ago

Summary

Script to compile all SDK guide README files:

for i in examples/charts/* examples/dashboard/*;
  do ./node_modules/markdown-include/bin/cli.js "${i}"/markdown.json;
done;

Updated file tree

charts-embed-sdk/examples
├── .md-config
│   ├── chart
|   |   ├── authenticated-custom-jwt.md     
|   |   └── ...other md config files            
|   └── dashboard
│       └── ...other md config files        
├── charts
│   ├── authenticated-custom-jwt
|   |   ├── assets
|   |   ├── src     
|   |   ├── app.js  
|   |   ├── index.html 
|   |   ├── markdown.json       
|   |   ├── package.json    
|   |   ├── package.json    
|   |   └── package-lock.json 
|   └── ...other examples   
├── dashboard
|   └── ...other examples   
├── docs
│   ├── chart
|   |   └── ...partial md files
|   ├── dashboard
|   |   └── ...partial md files
|   └── ...partial md files
└── README.md