Skip to content

Commit 0a681c2

Browse files
authored
Web Frameworks docs formatting for DevSite (firebase#5645)
* Removing slashes and editing the linter ignore file to allow them (as required by DevSite).
1 parent 9714a6f commit 0a681c2

File tree

5 files changed

+17
-15
lines changed

5 files changed

+17
-15
lines changed

.eslintrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,5 +124,6 @@ module.exports = {
124124
"src/dynamicImport.js",
125125
"scripts/webframeworks-deploy-tests/hosting/**",
126126
"scripts/frameworks-tests/vite-project/**",
127+
"/src/frameworks/docs/**",
127128
],
128129
};

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
/lib/**/*
44
/CONTRIBUTING.md
55
/scripts/frameworks-tests/vite-project/**
6+
/src/frameworks/docs/**

src/frameworks/docs/angular.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Project: /docs/hosting/\_project.yaml
2-
Book: /docs/\_book.yaml
1+
Project: /docs/hosting/_project.yaml
2+
Book: /docs/_book.yaml
33
page_type: guide
44

55
{% include "_shared/apis/console/_local_variables.html" %}
@@ -13,13 +13,13 @@ page_type: guide
1313
With the Firebase framework-aware {{cli}}, you can deploy your Angular application
1414
to Firebase and serve dynamic content to your users.
1515

16-
<<\_includes/\_preview-disclaimer.md>>
16+
<<_includes/_preview-disclaimer.md>>
1717

18-
<<\_includes/\_before-you-begin.md>>
18+
<<_includes/_before-you-begin.md>>
1919

2020
- Optional: AngularFire
2121

22-
<<\_includes/\_initialize-firebase.md>>
22+
<<_includes/_initialize-firebase.md>>
2323

2424
1. Choose your hosting source directory; this could be an existing Angular app.
2525
1. Choose "Dynamic web hosting with web framework."

src/frameworks/docs/express.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Project: /docs/hosting/\_project.yaml
2-
Book: /docs/\_book.yaml
1+
Project: /docs/hosting/_project.yaml
2+
Book: /docs/_book.yaml
33
page_type: guide
44

55
{% include "_shared/apis/console/_local_variables.html" %}
@@ -14,14 +14,14 @@ With some additional configuration, you can build on the basic
1414
framework-aware {{cli}} functionality
1515
to extend integration support to frameworks other than Angular and Next.js.
1616

17-
<<\_includes/\_preview-disclaimer.md>>
17+
<<_includes/_preview-disclaimer.md>>
1818

19-
<<\_includes/\_before-you-begin.md>>
19+
<<_includes/_before-you-begin.md>>
2020

2121
- Optional: Billing enabled on your Firebase project
2222
(required if you plan to use SSR)
2323

24-
<<\_includes/\_initialize-firebase.md>>
24+
<<_includes/_initialize-firebase.md>>
2525

2626
1. Choose your hosting source directory; this could be an existing web app.
2727
1. Choose "Dynamic web hosting with web framework."

src/frameworks/docs/nextjs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Project: /docs/hosting/\_project.yaml
2-
Book: /docs/\_book.yaml
1+
Project: /docs/hosting/_project.yaml
2+
Book: /docs/_book.yaml
33
page_type: guide
44

55
{% include "_shared/apis/console/_local_variables.html" %}
@@ -16,16 +16,16 @@ translates them to Firebase settings with zero or minimal extra configuration on
1616
your part. If your app includes dynamic server-side logic, the {{cli}} deploys that
1717
logic to {{cloud_functions_full}}.ß
1818

19-
<<\_includes/\_preview-disclaimer.md>>
19+
<<_includes/_preview-disclaimer.md>>
2020

21-
<<\_includes/\_before-you-begin.md>>
21+
<<_includes/_before-you-begin.md>>
2222

2323
- Optional: Billing enabled on your Firebase project
2424
(required if you plan to use SSR)
2525
- Optional: use the experimental ReactFire library to benefit from its
2626
Firebase-friendly features
2727

28-
<<\_includes/\_initialize-firebase.md>>
28+
<<_includes/_initialize-firebase.md>>
2929

3030
1. Choose your hosting source directory. If this an existing Next.js app,
3131
the {{cli}} process completes, and you can proceed to the next section.

0 commit comments

Comments
 (0)