fix: removing toc to fix the docs html (faker-js#341)

Co-authored-by: Shinigami <[email protected]>

Author: 2 people

.gitignore

@@ -91,3 +91,6 @@ REVISION
 .yarn/
 package-lock.json
 yarn.lock
+
+cypress/screenshots
+cypress/videos

cypress.json

@@ -1,6 +1,7 @@
 {
   "video": false,
   "e2e": {
+    "chromeWebSecurity": false,
     "baseUrl": "http://localhost:5000",
     "integrationFolder": "cypress/e2e",
     "testFiles": "**/*.cy.*",

cypress/e2e/smoke.cy.ts

@@ -1,11 +1,26 @@
 describe('Smoke Test', () => {
-  it('compiles the guide page', () => {
+  beforeEach(() => {
     cy.visit('/guide/');
+    cy.get('a[href="/api/animal.html"]').as('firstSectionLink');
+  });
+
+  it('compiles the guide page', () => {
     cy.contains('Getting Started');
   });
 
-  // it('compiles the playground page', () => {
-  //   cy.visit('/playground/');
-  //   cy.contains('Playground under construction');
-  // });
+  it('renders this last code example in the code', () => {
+    // Click on any section in the sidebar
+    cy.get('@firstSectionLink')
+      .click()
+      // Make sure the number of code examples is the same between reloads
+      .get('.container pre code')
+      .then(($codeBlocks) => {
+        // Trigger a reload
+        cy.reload()
+          // Give the runtime a chance to update/fail
+          .wait(500)
+          .get('.container pre code')
+          .should('have.length', $codeBlocks.length);
+      });
+  });
 });

scripts/apidoc.ts

@@ -102,8 +102,6 @@ async function build(): Promise<void> {
       <!-- This file is automatically generated. -->
       <!-- Run '${scriptCommand}' to update -->
 
-      [[toc]]
-
       ::: v-pre
 
       ${toBlock(module.comment)}