Skip to content

Commit

Permalink
Merge pull request #15 from wpdas/staging
Browse files Browse the repository at this point in the history
docs updated for lib beta.18
  • Loading branch information
wpdas committed Apr 16, 2024
2 parents e0ca16c + fe11518 commit e423df3
Show file tree
Hide file tree
Showing 17 changed files with 1,482 additions and 24 deletions.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
"repository": "https://github.com/wpdas/alem-docs-web.git",
"license": "MIT",
"scripts": {
"start": "MINIFY=false NODE_ENV=development alem dev --network testnet",
"start:mainnet": "MINIFY=false NODE_ENV=development alem dev",
"start": "alem dev --network testnet",
"start:mainnet": "alem dev",
"generate-tsx-from-md": "node ./scripts/generate-tsx-from-md",
"build": "alem build",
"deploy:mainnet": "npm run build; alem deploy",
"deploy:testnet": "npm run build; alem deploy --network testnet"
},
"dependencies": {
"alem": "1.0.0-beta.15"
"alem": "1.0.0-beta.18"
},
"devDependencies": {
"@types/styled-components": "^5.1.26",
Expand Down
2 changes: 1 addition & 1 deletion src/components/MobileNavBar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const MobileNavBar = () => {
</div>

<div>
<h3>Modules (Experimental)</h3>
<h3>Modules</h3>
{modulesItems}
</div>

Expand Down
2 changes: 1 addition & 1 deletion src/components/Sidebar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const Sidebar = () => {
</div>

<div>
<h3>Modules (Experimental)</h3>
<h3>Modules</h3>
{modulesItems}
</div>

Expand Down
2 changes: 1 addition & 1 deletion src/md/Cli.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const Cli = () => {
const mdContent = Buffer.from(`IyBBbMOpbSBDTEkKCkFsw6ltIGhhcyBpdHMgb3duIGNvbW1hbmQgc3lzdGVtLgoKIyMjIENvbW1hbmRzCgpgYGBiYXNoClVzYWdlOiBhbGVtIFtvcHRpb25zXSBbY29tbWFuZF0KCk9wdGlvbnM6CiAgLVYsIC0tdmVyc2lvbiAgIG91dHB1dCB0aGUgdmVyc2lvbiBudW1iZXIKICAtaCwgLS1oZWxwICAgICAgZGlzcGxheSBoZWxwIGZvciBjb21tYW5kCgpDb21tYW5kczoKICBkZXYgW29wdGlvbnNdICAgICAgICAgICAgICBSdW4gdGhlIGRldmVsb3BtZW50IHNlcnZlcgogIGJ1aWxkICAgICAgICAgICAgICAgICAgICAgIEJ1aWxkIHRoZSBwcm9qZWN0CiAgZGVwbG95IFtvcHRpb25zXSAgICAgICAgICAgRGVwbG95IHRoZSBwcm9qZWN0CiAgdXBsb2FkLW1ldGFkYXRhIFtvcHRpb25zXSAgVXBsb2FkIG1ldGFkYXRhIHRvIFNvY2lhbERCIChhcHAgbmFtZSwgZGVzY3JpcHRpb24sIGljb24sIHRhZ3MsIGV0YykKYGBgCgojIyMjIENvbW1hbmQ6IGBkZXZgCgpSdW4gdGhlIGRldmVsb3BtZW50IHNlcnZlciB3aXRoIHZhcmlvdXMgb3B0aW9uczoKCmBgYGJhc2gKVXNhZ2U6IGFsZW0gZGV2IFtvcHRpb25zXQoKT3B0aW9uczoKICAtbiwgLS1uZXR3b3JrIDxuZXR3b3JrPiAgTmV0d29yayB3aGVyZSB0aGUgYXBwIHdpbGwgYmUgcnVubmluZyAoZGVmYXVsdDogIm1haW5uZXQiKQogIC1wLCAtLXBvcnQgPHBvcnQ+ICAgICAgICBQb3J0IHRvIHJ1biB0aGUgc2VydmVyIG9uIChkZWZhdWx0OiA4MDgwKQogIC1uby1vcGVuICAgICAgICAgICAgICAgICBEaXNhYmxlIG9wZW5pbmcgdGhlIGJyb3dzZXIgKGRlZmF1bHQ6IGZhbHNlKQpgYGAKCiMjIyMgQ29tbWFuZDogYGJ1aWxkYAoKQnVpbGQgdGhlIHByb2plY3Q6CgpgYGBiYXNoClVzYWdlOiBhbGVtIGJ1aWxkCmBgYAoKVGhpcyB3aWxsIG91dHB1dCB2YWxpZCB3aWRnZXQgY29kZSB0byB0aGUgYC9idWlsZGAgZGlyZWN0b3J5LgoKIyMjIyBDb21tYW5kOiBgZGVwbG95YAoKRGVwbG95IHRoZSBwcm9qZWN0IHRvIE5lYXIgQk9TOgoKYGBgYmFzaApVc2FnZTogYWxlbSBkZXBsb3kgW29wdGlvbnNdCgpPcHRpb25zOgogIC1uLCAtLW5ldHdvcmsgPG5ldHdvcms+ICBOZXR3b3JrIHdoZXJlIHRoZSBhcHAgc2hvdWxkIGJlIGRlcGxveWVkIChkZWZhdWx0OiAibWFpbm5ldCIpCiAgLWgsIC0taGVscCAgICAgICAgICAgICAgIGRpc3BsYXkgaGVscCBmb3IgY29tbWFuZApgYGAKCiMjIyMgQ29tbWFuZDogYHVwbG9hZC1tZXRhZGF0YWAKClVwbG9hZCBtZXRhZGF0YSB0byBTb2NpYWxEQi4gVGhpcyBpcyBnb2luZyB0byB1c2UgdGhlIGRhdGEgcHJvdmlkZWQgYnkgYGFsZW0uY29uZmlnLmpzb25gIGZpbGUuIFRoZSBjb250ZW50IHJlcHJlc2VudHMgdGhlIGFwcCdzIGRldGFpbHMgbGlrZSBgbmFtZSwgZGVzY3JpcHRpb24sIGljb24sIHRhZ3MsIGV0Y2AuIFlvdSBjYW4gdXBkYXRlIHRoaXMgaW5mb3JtYXRpb24gbWFudWFsbHkgYnkgZ29pbmcgdG8gdGhlIHdpZGdldCBtZXRhZGF0YSB0YWIgdXNpbmcgdGhlIFtOZWFyIFNhbmRib3hdKGh0dHBzOi8vbmVhci5vcmcvc2FuZGJveCkuCgpgYGBiYXNoClVzYWdlOiBhbGVtIHVwbG9hZC1tZXRhZGF0YSBbb3B0aW9uc10KCk9wdGlvbnM6CiAgLW4sIC0tbmV0d29yayA8bmV0d29yaz4gIE5ldHdvcmsgd2hlcmUgdGhlIG1ldGFkYXRhIHNob3VsZCBiZSBkZXBsb3llZCAoZGVmYXVsdDogIm1haW5uZXQiKQogIC1oLCAtLWhlbHAgICAgICAgICAgICAgICBkaXNwbGF5IGhlbHAgZm9yIGNvbW1hbmQKYGBgCg==`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBBbMOpbSBDTEkKCkFsw6ltIGhhcyBpdHMgb3duIGNvbW1hbmQgc3lzdGVtLiBUbyB1c2UgaXQsIGluc3RhbGwgQWzDqW0gZ2xvYmFsbHkuCgpgYGBzaAojIG5wbQpucG0gaW5zdGFsbCBhbGVtIC1nCmBgYAoKYGBgc2gKIyB5YXJuCnlhcm4gZ2xvYmFsIGFkZCBhbGVtCmBgYAoKIyMjIENvbW1hbmRzCgpgYGBiYXNoClVzYWdlOiBhbGVtIFtvcHRpb25zXSBbY29tbWFuZF0KCk9wdGlvbnM6CiAgLVYsIC0tdmVyc2lvbiAgIG91dHB1dCB0aGUgdmVyc2lvbiBudW1iZXIKICAtaCwgLS1oZWxwICAgICAgZGlzcGxheSBoZWxwIGZvciBjb21tYW5kCgpDb21tYW5kczoKICBkZXYgW29wdGlvbnNdICAgICAgICAgICAgICBSdW4gdGhlIGRldmVsb3BtZW50IHNlcnZlcgogIGJ1aWxkICAgICAgICAgICAgICAgICAgICAgIEJ1aWxkIHRoZSBwcm9qZWN0CiAgZGVwbG95IFtvcHRpb25zXSAgICAgICAgICAgRGVwbG95IHRoZSBwcm9qZWN0CiAgdXBsb2FkLW1ldGFkYXRhIFtvcHRpb25zXSAgVXBsb2FkIG1ldGFkYXRhIHRvIFNvY2lhbERCIChhcHAgbmFtZSwgZGVzY3JpcHRpb24sIGljb24sIHRhZ3MsIGV0YykKYGBgCgojIyMjIENvbW1hbmQ6IGBkZXZgCgpSdW4gdGhlIGRldmVsb3BtZW50IHNlcnZlciB3aXRoIHZhcmlvdXMgb3B0aW9uczoKCmBgYGJhc2gKVXNhZ2U6IGFsZW0gZGV2IFtvcHRpb25zXQoKT3B0aW9uczoKICAtbiwgLS1uZXR3b3JrIDxuZXR3b3JrPiAgTmV0d29yayB3aGVyZSB0aGUgYXBwIHdpbGwgYmUgcnVubmluZyAoZGVmYXVsdDogIm1haW5uZXQiKQogIC1wLCAtLXBvcnQgPHBvcnQ+ICAgICAgICBQb3J0IHRvIHJ1biB0aGUgc2VydmVyIG9uIChkZWZhdWx0OiA4MDgwKQogIC1uby1vcGVuICAgICAgICAgICAgICAgICBEaXNhYmxlIG9wZW5pbmcgdGhlIGJyb3dzZXIgKGRlZmF1bHQ6IGZhbHNlKQpgYGAKCiMjIyMgQ29tbWFuZDogYGJ1aWxkYAoKQnVpbGQgdGhlIHByb2plY3Q6CgpgYGBiYXNoClVzYWdlOiBhbGVtIGJ1aWxkCmBgYAoKVGhpcyB3aWxsIG91dHB1dCB2YWxpZCB3aWRnZXQgY29kZSB0byB0aGUgYC9idWlsZGAgZGlyZWN0b3J5LgoKIyMjIyBDb21tYW5kOiBgZGVwbG95YAoKRGVwbG95IHRoZSBwcm9qZWN0IHRvIE5lYXIgQk9TOgoKYGBgYmFzaApVc2FnZTogYWxlbSBkZXBsb3kgW29wdGlvbnNdCgpPcHRpb25zOgogIC1uLCAtLW5ldHdvcmsgPG5ldHdvcms+ICBOZXR3b3JrIHdoZXJlIHRoZSBhcHAgc2hvdWxkIGJlIGRlcGxveWVkIChkZWZhdWx0OiAibWFpbm5ldCIpCiAgLWgsIC0taGVscCAgICAgICAgICAgICAgIGRpc3BsYXkgaGVscCBmb3IgY29tbWFuZApgYGAKCiMjIyMgQ29tbWFuZDogYHVwbG9hZC1tZXRhZGF0YWAKClVwbG9hZCBtZXRhZGF0YSB0byBTb2NpYWxEQi4gVGhpcyBpcyBnb2luZyB0byB1c2UgdGhlIGRhdGEgcHJvdmlkZWQgYnkgYGFsZW0uY29uZmlnLmpzb25gIGZpbGUuIFRoZSBjb250ZW50IHJlcHJlc2VudHMgdGhlIGFwcCdzIGRldGFpbHMgbGlrZSBgbmFtZSwgZGVzY3JpcHRpb24sIGljb24sIHRhZ3MsIGV0Y2AuIFlvdSBjYW4gdXBkYXRlIHRoaXMgaW5mb3JtYXRpb24gbWFudWFsbHkgYnkgZ29pbmcgdG8gdGhlIHdpZGdldCBtZXRhZGF0YSB0YWIgdXNpbmcgdGhlIFtOZWFyIFNhbmRib3hdKGh0dHBzOi8vbmVhci5vcmcvc2FuZGJveCkuCgpgYGBiYXNoClVzYWdlOiBhbGVtIHVwbG9hZC1tZXRhZGF0YSBbb3B0aW9uc10KCk9wdGlvbnM6CiAgLW4sIC0tbmV0d29yayA8bmV0d29yaz4gIE5ldHdvcmsgd2hlcmUgdGhlIG1ldGFkYXRhIHNob3VsZCBiZSBkZXBsb3llZCAoZGVmYXVsdDogIm1haW5uZXQiKQogIC1oLCAtLWhlbHAgICAgICAgICAgICAgICBkaXNwbGF5IGhlbHAgZm9yIGNvbW1hbmQKYGBgCg==`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
2 changes: 1 addition & 1 deletion src/md/CssFiles.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const CssFiles = () => {
const mdContent = Buffer.from(`IyBDU1MgRmlsZXMKCkR1cmluZyBjb21waWxhdGlvbiwgY3NzIGZpbGVzIGFyZSBtZXJnZWQgYW5kIGJlY29tZSBqdXN0IG9uZSwgc28gYmUgY2FyZWZ1bCBub3QgdG8gb3ZlcndyaXRlIGNlcnRhaW4gcmVzb3VyY2VzIHN1Y2ggYXMgY2xhc3Nlcy4gUHJlZmVyIHRvIHVzZSBgc3R5bGVkLWNvbXBvbmVudHNgIGFzIHRoaXMgdHlwZSBvZiBwcm9ibGVtIGlzIGF1dG9tYXRpY2FsbHkgY29ycmVjdGVkIGJ5IHRoZSBjb21waWxlci4K`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBDU1MgRmlsZXMKCkR1cmluZyBjb21waWxhdGlvbiwgY3NzIGZpbGVzIGFyZSBtZXJnZWQgYW5kIGJlY29tZSBqdXN0IG9uZSwgc28gYmUgY2FyZWZ1bCBub3QgdG8gb3ZlcndyaXRlIGNlcnRhaW4gcmVzb3VyY2VzIHN1Y2ggYXMgY2xhc3Nlcy4gUHJlZmVyIHRvIHVzZSBgc3R5bGVkLWNvbXBvbmVudHNgIGFzIHRoaXMgdHlwZSBvZiBwcm9ibGVtIGlzIGF1dG9tYXRpY2FsbHkgY29ycmVjdGVkIGJ5IHRoZSBjb21waWxlci4KCioqY3NzIG1vZHVsZXMqKiBmZWF0dXJlIGlzIGJlaW5nIGRldmVsb3BlZCBhbmQgd2lsbCBiZSBhdmFpbGFibGUgaW4gdGhlIG5leHQgdmVyc2lvbnMuIFdoZW4gdGhpcyBpcyBkb25lLCB0aGUgY3NzIGZpbGVzIHdpbGwgbm8gbG9uZ2VyIGJlIG1lcmdlZCBpbiBvbmUuCg==`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
8 changes: 8 additions & 0 deletions src/md/Environment.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { Markdown } from 'alem';

const Environment = () => {
const mdContent = Buffer.from(`IyBFbnZpcm9ubWVudAoKQ3JlYXRlIGEgYC5lbnZgIGZpbGUgdG8gc2V0IHVwIHRoZSBwcm9qZWN0J3MgZW52aXJvbm1lbnQgYW5kIG90aGVyIHZhcnMuCgoqKmRldmVsb3BtZW50OioqIGFkZCBgTk9ERV9FTlY9ZGV2ZWxvcG1lbnRgIHRvIHlvdXIgYC5lbnZgIGZpbGUuIFRoaXMgd2lsbCBzZXQgdGhlIHByb2plY3QgZW52IGFzIGBkZXZlbG9wbWVudGAuCgpUaGUgYWJzZW5jZSBvZiB0aGUgYC5lbnZgIGZpbGUgbWVhbnMgdGhhdCBgTk9ERV9FTlY9cHJvZHVjdGlvbmAuCg==`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

export default Environment;
2 changes: 1 addition & 1 deletion src/md/Installation.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const Installation = () => {
const mdContent = Buffer.from(`IyBJbnN0YWxsYXRpb24KCioqWW914oCZbGwgbmVlZCB0byBoYXZlIE5vZGUgMTguMC4wIG9yIGxhdGVyIHZlcnNpb24gb24geW91ciBsb2NhbCBkZXZlbG9wbWVudCBtYWNoaW5lKiouIFlvdSBjYW4gdXNlIFtudm1dKGh0dHBzOi8vZ2l0aHViLmNvbS9jcmVhdGlvbml4L252bSNpbnN0YWxsYXRpb24pIChtYWNPUy9MaW51eCkgb3IgW252bS13aW5kb3dzXShodHRwczovL2dpdGh1Yi5jb20vY29yZXlidXRsZXIvbnZtLXdpbmRvd3Mjbm9kZS12ZXJzaW9uLW1hbmFnZXItbnZtLWZvci13aW5kb3dzKSB0byBzd2l0Y2ggTm9kZSB2ZXJzaW9ucyBiZXR3ZWVuIGRpZmZlcmVudCBwcm9qZWN0cy4KClVzZSB0aGUgY29tbWFuZCBiZWxvdyB0byBzdGFydCBhbiBpbml0aWFsIGJvaWxlcnBsYXRlLgoKIyMjIEphdmFTY3JpcHQKCmBgYHNoCiMgTnB4Cm5weCBjcmVhdGUtYWxlbS1kYXBwIG15LWFwcApjZCBteS1hcHAKbnBtIHN0YXJ0CmBgYAoKYGBgc2gKIyBZYXJuCnlhcm4gY3JlYXRlIGFsZW0tZGFwcCBteS1hcHAKY2QgbXktYXBwCnlhcm4gc3RhcnQKYGBgCgojIyMgVHlwZVNjcmlwdAoKYGBgc2gKIyBOcHgKbnB4IGNyZWF0ZS1hbGVtLWRhcHAgbXktYXBwIC0tdGVtcGxhdGUgdHlwZXNjcmlwdApjZCBteS1hcHAKbnBtIHN0YXJ0CmBgYAoKYGBgc2gKIyBZYXJuCnlhcm4gY3JlYXRlIGFsZW0tZGFwcCBteS1hcHAgLS10ZW1wbGF0ZSB0eXBlc2NyaXB0CmNkIG15LWFwcAp5YXJuIHN0YXJ0CmBgYAo=`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBJbnN0YWxsYXRpb24KCioqWW914oCZbGwgbmVlZCB0byBoYXZlIE5vZGUgMTguMC4wIG9yIGxhdGVyIHZlcnNpb24gb24geW91ciBsb2NhbCBkZXZlbG9wbWVudCBtYWNoaW5lKiouIFlvdSBjYW4gdXNlIFtudm1dKGh0dHBzOi8vZ2l0aHViLmNvbS9jcmVhdGlvbml4L252bSNpbnN0YWxsYXRpb24pIChtYWNPUy9MaW51eCkgb3IgW252bS13aW5kb3dzXShodHRwczovL2dpdGh1Yi5jb20vY29yZXlidXRsZXIvbnZtLXdpbmRvd3Mjbm9kZS12ZXJzaW9uLW1hbmFnZXItbnZtLWZvci13aW5kb3dzKSB0byBzd2l0Y2ggTm9kZSB2ZXJzaW9ucyBiZXR3ZWVuIGRpZmZlcmVudCBwcm9qZWN0cy4KCkFsc28sIG1ha2Ugc3VyZSB5b3UgaGF2ZSAqKkdpdCoqIGluc3RhbGxlZCBvbiB5b3VyIG1hY2hpbmUuCgpVc2UgdGhlIGNvbW1hbmQgYmVsb3cgdG8gc3RhcnQgYW4gaW5pdGlhbCBib2lsZXJwbGF0ZS4KCiMjIyBKYXZhU2NyaXB0CgpgYGBzaAojIE5weApucHggY3JlYXRlLWFsZW0tZGFwcCBteS1hcHAKY2QgbXktYXBwCm5wbSBzdGFydApgYGAKCmBgYHNoCiMgWWFybgp5YXJuIGNyZWF0ZSBhbGVtLWRhcHAgbXktYXBwCmNkIG15LWFwcAp5YXJuIHN0YXJ0CmBgYAoKIyMjIFR5cGVTY3JpcHQKCmBgYHNoCiMgTnB4Cm5weCBjcmVhdGUtYWxlbS1kYXBwIG15LWFwcCAtLXRlbXBsYXRlIHR5cGVzY3JpcHQKY2QgbXktYXBwCm5wbSBzdGFydApgYGAKCmBgYHNoCiMgWWFybgp5YXJuIGNyZWF0ZSBhbGVtLWRhcHAgbXktYXBwIC0tdGVtcGxhdGUgdHlwZXNjcmlwdApjZCBteS1hcHAKeWFybiBzdGFydApgYGAK`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
2 changes: 1 addition & 1 deletion src/md/api/IsDevelopment.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Markdown } from 'alem';

const IsDevelopment = () => {
const mdContent = Buffer.from(`IyBpc0RldmVsb3BtZW50CgpVc2VmdWwgZmVhdHVyZSB0byBrbm93IGlmIHRoZSBlbnZpcm9ubWVudCBpcyBkZXZlbG9wbWVudCBvciBwcm9kdWN0aW9uLgoKYGBgdHN4CmltcG9ydCB7IGlzRGV2ZWxvcG1lbnQgfSBmcm9tICJhbGVtIjsKCmNvbnN0IGFuc3dlciA9IGlzRGV2ZWxvcG1lbnQgPyAiWWVwIiA6ICJOb3BlIjsKYGBgCg==`, "base64").toString("utf-8");
const mdContent = Buffer.from(`IyBpc0RldmVsb3BtZW50CgpVc2VmdWwgZmVhdHVyZSB0byBrbm93IGlmIHRoZSBlbnZpcm9ubWVudCBpcyBkZXZlbG9wbWVudCBvciBwcm9kdWN0aW9uLiBVc2UgYC5lbnZgIHRvIHNldCB0aGUgZW52aXJvbm1lbnQuCgpgYGBzaAojIHNldCB0aGUgcHJvamVjdCdzIGVudmlyb25tZW50Ck5PREVfRU5WPWRldmVsb3BtZW50CmBgYAoKYGBgdHN4CmltcG9ydCB7IGlzRGV2ZWxvcG1lbnQgfSBmcm9tICJhbGVtIjsKCmNvbnN0IGFuc3dlciA9IGlzRGV2ZWxvcG1lbnQgPyAiWWVwIiA6ICJOb3BlIjsKYGBgCg==`, "base64").toString("utf-8");
return <Markdown text={mdContent} />
}

Expand Down
7 changes: 6 additions & 1 deletion src/md/api/is-development.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# isDevelopment

Useful feature to know if the environment is development or production.
Useful feature to know if the environment is development or production. Use `.env` to set the environment.

```sh
# set the project's environment
NODE_ENV=development
```

```tsx
import { isDevelopment } from "alem";
Expand Down
12 changes: 11 additions & 1 deletion src/md/cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Além CLI

Além has its own command system.
Além has its own command system. To use it, install Além globally.

```sh
# npm
npm install alem -g
```

```sh
# yarn
yarn global add alem
```

### Commands

Expand Down
2 changes: 2 additions & 0 deletions src/md/css-files.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# CSS Files

During compilation, css files are merged and become just one, so be careful not to overwrite certain resources such as classes. Prefer to use `styled-components` as this type of problem is automatically corrected by the compiler.

**css modules** feature is being developed and will be available in the next versions. When this is done, the css files will no longer be merged in one.
7 changes: 7 additions & 0 deletions src/md/environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Environment

Create a `.env` file to set up the project's environment and other vars.

**development:** add `NODE_ENV=development` to your `.env` file. This will set the project env as `development`.

The absence of the `.env` file means that `NODE_ENV=production`.
2 changes: 2 additions & 0 deletions src/md/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

**You’ll need to have Node 18.0.0 or later version on your local development machine**. You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects.

Also, make sure you have **Git** installed on your machine.

Use the command below to start an initial boilerplate.

### JavaScript
Expand Down
4 changes: 3 additions & 1 deletion src/routes/Routes.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { AboutPage } from "../pages/About/About";
import { RoutesPath } from "./routeProps";
import nextPrevRoutes from "./nextPrevRoutes";
import getRouteTitleByPath from "./getRouteTitleByPath";
import { FooterNavContainer, NextPrevButton } from "./styles";
import FeatureOverview from "@md/FeatureOverview";
import Installation from "@md/Installation";
import ConfigFile from "@md/ConfigFile";
Expand All @@ -23,7 +24,7 @@ import RoutesDocs from "@md/router/RoutesDocs";
import CssFiles from "@app/md/CssFiles";
import InstallingModules from "@app/md/modules/InstallingModules";
import HowToUseModules from "@app/md/modules/HowToUseModules";
import { FooterNavContainer, NextPrevButton } from "./styles";
import Environment from "@app/md/Environment";

const Routes = () => {
const urlParams = useParams();
Expand All @@ -45,6 +46,7 @@ const Routes = () => {
createRoute(RoutesPath.cssFiles.path, CssFiles),
createRoute(RoutesPath.cli.path, Cli),
createRoute(RoutesPath.deployingWithGithubActions.path, DeployingWithGithubActions),
createRoute(RoutesPath.environment.path, Environment),

// Router
createRoute(RoutesPath.routes.path, RoutesDocs),
Expand Down
5 changes: 5 additions & 0 deletions src/routes/nextPrevRoutes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ const nextPrevRoutes = () => ({

[RoutesPath.deployingWithGithubActions.path]: {
prev: RoutesPath.cli.path,
next: RoutesPath.environment.path,
},

[RoutesPath.environment.path]: {
prev: RoutesPath.deployingWithGithubActions.path,
next: RoutesPath.installingModules.path,
},

Expand Down
6 changes: 6 additions & 0 deletions src/routes/routeProps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ export const RoutesPath = {
category: Categories.gettingStarted,
},

environment: {
path: "environment",
title: "Environment",
category: Categories.gettingStarted,
},

// Modules
installingModules: {
path: "installing-modules",
Expand Down
Loading

0 comments on commit e423df3

Please sign in to comment.