Skip to content

Commit

Permalink
Update the output dir of generate-docs.js
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisli30 committed Nov 22, 2024
1 parent 3df3788 commit 5a91074
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions scripts/generate-docs.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
/**
* This script generates the SDK reference documentation based on the methods array defined at the beginning of the file.
* For a generated example, please refer to https://avaprotocol.org/docs/ethereum/develop/js-sdk
*
*
* Usage:
* node ./scripts/generate-docs.js
*/

const fs = require("fs");

const OUTPUT_DIR = "./scripts"; // The directory to output the generated documentation; setting is to ./scripts for now.
const OUTPUT_FILENAME = "SDK_References.md";

const methods = [
Expand Down Expand Up @@ -222,6 +223,6 @@ const generateMarkdown = (methods) => {

const markdown = generateMarkdown(methods);

fs.writeFileSync(OUTPUT_FILENAME, markdown);
fs.writeFileSync(`${OUTPUT_DIR}/${OUTPUT_FILENAME}`, markdown);

console.log(`Documentation generated: ${OUTPUT_FILENAME}`);
console.log(`Documentation generated: ${OUTPUT_DIR}/${OUTPUT_FILENAME}`);

0 comments on commit 5a91074

Please sign in to comment.