Skip to content

This repo helps you convert a data export (folder or file) to an MDX schema you can use for documentation on Surfer Protocol

Notifications You must be signed in to change notification settings

Surfer-Org/auto-schema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Surfer Protocol Auto-Schema

This script is used to automatically generate .mdx code for an exporting method for a platform.

How to use

  1. Clone the repo
git clone https://github.com/surfer-protocol/auto-schema.git
  1. Put the filepath of the zip file in the select_file() function in app.py
  2. Run the script
  3. Find the generated .mdx file in the same directory as the script. It will be named like z_generated_mdx_<timestamp>.mdx
  4. Copy and paste the contents of the .mdx file into platform-[export-method-name].mdx in the Surfer Protocol repo.

About

This repo helps you convert a data export (folder or file) to an MDX schema you can use for documentation on Surfer Protocol

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages