Initial commit

Author: nimish-ks

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

.gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+#yarn.lock
+
+# local env files
+.env
+.env.local
+
+# vercel
+.vercel

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.enableFiletypes": ["mdx"]
+}

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing to Phase Docs
+
+We're excited that you're interested in contributing to Phase Docs! This document outlines the process for contributing and provides instructions for setting up the project locally.
+
+## How to Contribute
+
+1. Fork the repository.
+2. Create a new branch for your contribution.
+3. Make your changes.
+4. Submit a pull request with a clear description of your changes.
+
+## Setting Up the Development Environment
+
+### Installation
+
+You can install the project dependencies using either npm or yarn:
+
+#### npm
+
+```bash
+npm install
+```
+
+#### yarn
+
+```bash
+yarn install
+```
+
+### Development
+
+To run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+### Building
+
+To build the project:
+
+```bash
+npm run build
+# or
+yarn build
+```
+
+This command will also generate a sitemap automatically after the build process.
+
+### Starting the Production Server
+
+To start the production server:
+
+```bash
+npm run start
+# or
+yarn start
+```
+
+### Linting
+
+To run the linter:
+
+```bash
+npm run lint
+# or
+yarn lint
+```
+
+## Documentation
+
+- Update the documentation if you're changing functionality.
+- Use clear and concise language in your documentation.
+- Provide examples where appropriate.
+
+## Submitting Changes
+
+1. Push your changes to your fork.
+2. Submit a pull request to the main repository.
+3. Clearly describe your changes and why you think they should be merged.
+4. Be prepared to address any feedback or questions about your pull request.
+
+## Questions?
+
+If you have any questions or need further clarification, you can get in touch with on in your [Community Slack](https://slack.phase.dev).
+
+Thank you for contributing to Phase Docs!

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Phase Security Inc.
+
+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.

README.md

@@ -0,0 +1,18 @@
+# Phase Docs
+
+![Phase Console](public/assets/images/phase-docs.png)
+
+This repository contains the documentation website for Phase. You can view the live docs at [https://docs.phase.dev](https://docs.phase.dev/).
+
+## Contributing
+
+We love contributions. Please see [CONTRIBUTING.md](/CONTRIBUTING.md)
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+
+The MIT License is a permissive license that is short and to the point. It lets people do anything they want with your code as long as they provide attribution back to you and don't hold you liable.
+
+Copyright (c) 2024 Phase Security Inc.

jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  }
+}

next-sitemap.config.js

@@ -0,0 +1,6 @@
+/** @type {import('next-sitemap').IConfig} */
+module.exports = {
+  siteUrl: process.env.SITE_URL || 'https://docs.phase.dev',
+  generateRobotsTxt: true, // (optional)
+  generateIndexSitemap: false,
+}

next.config.mjs

@@ -0,0 +1,29 @@
+import nextMDX from '@next/mdx'
+import { remarkPlugins } from './src/mdx/remark.mjs'
+import { rehypePlugins } from './src/mdx/rehype.mjs'
+import { recmaPlugins } from './src/mdx/recma.mjs'
+import withSearch from './src/mdx/search.mjs'
+
+const withMDX = nextMDX({
+  options: {
+    remarkPlugins,
+    rehypePlugins,
+    recmaPlugins,
+    providerImportSource: '@mdx-js/react',
+  },
+})
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: false,
+  output: 'export',
+  pageExtensions: ['js', 'jsx', 'ts', 'tsx', 'mdx'],
+  experimental: {
+    scrollRestoration: true,
+  },
+  images: {
+    unoptimized: true,
+  },
+}
+
+export default withSearch(withMDX(nextConfig))