Skip to content

Commit

Permalink
migrate to cypress.io docs theme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexjv89 committed Oct 5, 2023
1 parent 5111747 commit 353fe89
Show file tree
Hide file tree
Showing 165 changed files with 9,178 additions and 1,324 deletions.
66 changes: 26 additions & 40 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,50 +1,36 @@
# Generated files
.docusaurus
.cache-loader

# Dependencies
node_modules

# Production
build
dist

# Generated files
.docusaurus
.cache-loader

# Dependencies
node_modules
# Misc
.DS_Store
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

.DS_STORE
scripts/flow/*/.flowconfig
.flowconfig
*~
*.pyc
.grunt
_SpecRunner.html
__benchmarks__
remote-repo/
coverage/
.module-cache
fixtures/dom/public/react-dom.js
fixtures/dom/public/react.js
test/the-files-to-test.generated.js
*.log*
chrome-user-data
*.sublime-project
*.sublime-workspace
.idea
*.iml
.vscode
*.swp
*.swo
cypress/screenshots
cypress/videos

# Generated files
.docusaurus
.cache-loader

packages/react-devtools-core/dist
packages/react-devtools-extensions/chrome/build
packages/react-devtools-extensions/chrome/*.crx
packages/react-devtools-extensions/chrome/*.pem
packages/react-devtools-extensions/firefox/build
packages/react-devtools-extensions/firefox/*.xpi
packages/react-devtools-extensions/firefox/*.pem
packages/react-devtools-extensions/shared/build
packages/react-devtools-extensions/.tempUserDataDir
packages/react-devtools-inline/dist
packages/react-devtools-shell/dist
packages/react-devtools-timeline/dist
.nuxt
.husky
themes
.eslintcache
db.json
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.17.1
14 changes: 14 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
dist
.husky
.vscode
.circleci
.github
assets
node_modules
.eslintignore
.eslintcache
.eslintrc-textlint
.gitignore
.mergify.yml
.node-version
.textlintrc
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"semi": false,
"singleQuote": true,
"printWidth": 80,
"proseWrap": "preserve"
}
143 changes: 143 additions & 0 deletions .textlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
{
"rules": {
"eslint": {
"configFile": ".eslintrc-textlint",
"ignoreParsingErrors": true
},
"terminology": {
"defaultTerms": false,
"terms": [
// Cypress product
["^Cypress\.io", "Cypress"],
["Cypress' ", "Cypress's "],
["Cypress cloud", "Cypress Cloud"],

// Brands and Technologies
["ansi", "ANSI"],
"AppVeyor",
"Babel",
["^Blob(?! %)", "Blob"],
"Browserify",
"BrowserStack",
["^chai", "Chai"],
["^chai-jquery", "chai-jquery"],
["cross-browser", "cross browser"],
["cross origin", "cross-origin"],
["e-mail", "email"],
"ESLint",
["Express.js", "Express"],
"FFmpeg",
"GitHub",
"GraphQL",
["Hapi.js", "hapi"],
["iframe(s?)", "iframe$1"],
"iOS",
"Istanbul",
"JavaScript",
"Jest",
"jQuery",
"JSDoc",
["local[ ]?storage", "localStorage"],
"Lodash",
"minimatch",
"Mocha",
"node module",
"npm",
"online",
["React[ .]js", "React"],
"RegExp",
["SauceLabs", "Sauce Labs"],
["session[ ]?storage", "sessionStorage"],
"Single sign-on",
["^Sinon", "Sinon.JS"],
"Sinon–Chai",
"TypeScript",
"YouTube",
["VSCode", "VS Code"],
["^Vue", "Vue.JS"],
"WebKit",
"webpack",
["WebSocket(s?)", "WebSocket$1"],
"WiFi",

// Abbreviations
"API",
["API['’]?s", "APIs"],
"Ajax",
"CLI",
"CSS",
"CORS",
["^E2E", "E2E"],
["^gif", "GIF"],
["^HTML", "HTML"],
["^jpg", "JPG"],
["^URL(s?)", "URL$1"],
["^HTTP", "HTTP"],
["^HTTPS", "HTTPS"],
["^pdf", "PDF"],
"SSO",
["^XHR(s?)", "XHR$1"],
["^XHR['’]?s", "XHRs"],
"Xvfb",
"YAML",

// Words and phrases
["\\(s\\)he", "they"],
["he or she", "they"],
["he/she", "they"],
["crazy", "complex"],
["crazier", "more complex"],
["craziest", "most complex"],
["dumb", "unintended"],
["insane", "outrageous"],
["blacklist", "block"],
["whitelist", "allow"],

// Prefer American spelling
["behaviour", "behavior"],
["cancelled", "canceled"],
["cancelling", "canceling"],
["centre", "center"],
["colour", "color"],
["customise", "customize"],
["customisation", "customization"],
["favourite", "favorite"],
["labelled", "labeled"],
["licence", "license"],
["organise", "organize"],

// Common misspellings
["gaurantee", "guarantee"],

// Words we would like to not use altogether
["simply", ""],

// Single word
["change[- ]log(s?)", "changelog$1"],
["code[- ]base(es?)", "codebase$1"],
["e[- ]mail(s?)", "email$1"],
["end[- ]point(s?)", "endpoint$1"],
["file[- ]name(s?)", "filename$1"],
["can[- ]not", "cannot$1"],

// Multiple words
["back-?end(s?)", "back end$1"],
["front-?end(s?)", "front end$1"],
["full-?stack(s?)", "full stack$1"],
["open-?source(ed?)", "open source$1"],
["web-?page(s?)", "web page$1"],

// Hyphenated
["end ?to ?end", "end-to-end"],
["retryability", "retry-ability"],
["retriability", "retry-ability"],
]
}
},
"filters": {
"comments": {
"enablingComment": "textlint-enable",
"disablingComment": "textlint-disable"
}
}
}
20 changes: 20 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## MIT License

Copyright (c) 2023 Cashflowy.io https://cashflowy.io

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 changes: 13 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,34 @@
# Website
# Cashflowy Documentation

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
The code for Cashflowy Documentation found at https://docs.cashflowy.io.

Our docs are built using [Docusaurus 2](https://docusaurus.io/).

### Installation

```
$ yarn
$ npm i
```

### Local Development

```
$ yarn start
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```
This command generates static content into the `dist` directory and can be
served using any static contents hosting service.

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
## License

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
This project is licensed under the terms of the [MIT license](/LICENSE.md).
12 changes: 0 additions & 12 deletions blog/2019-05-28-first-blog-post.md

This file was deleted.

44 changes: 0 additions & 44 deletions blog/2019-05-29-long-blog-post.md

This file was deleted.

Loading

0 comments on commit 353fe89

Please sign in to comment.