在 AstroPaper 内部,您将看到以下文件夹和文件:
/
├── public/
│ ├── assets/
│ │ └── logo.svg
│ │ └── logo.png
│ └── favicon.svg
│ └── astropaper-og.jpg
│ └── robots.txt
│ └── toggle-theme.js
├── src/
│ ├── assets/
│ │ └── socialIcons.ts
│ ├── components/
│ ├── content/
│ │ | blog/
│ │ | └── some-blog-posts.md
│ │ └── config.ts
│ ├── layouts/
│ └── pages/
│ └── styles/
│ └── utils/
│ └── config.ts
│ └── types.ts
└── package.json
Astro 在src/pages/
目录中查找.astro
或.md
文件。每个页面都根据其文件名公开为路径。
任何静态资源(例如图像)都可以放置在public/
目录中。
所有博客文章都存储在src/content/blog
目录中。
文档可以以两种格式阅读: markdown和博客文章。
对于 AstroPaper v1,请查看此分支和此实时 URL
主框架-Astro
类型检查- TypeScript
组件框架- ReactJS
样式- TailwindCSS
UI/UX - Figma 设计文件
模糊搜索- FuseJS
图标-Boxicons |桌子人
代码格式化- Prettier
部署- Cloudflare 页面
关于页面中的插图- https://freesvgillustration.com
Linting - ESLint
您可以通过在所需目录中运行以下命令来在本地开始使用该项目:
# npm 6.x
npm create astro@latest --template satnaing/astro-paper
# npm 7+, extra double-dash is needed:
npm create astro@latest -- --template satnaing/astro-paper
# yarn
yarn create astro --template satnaing/astro-paper
# pnpm
pnpm dlx create-astro --template satnaing/astro-paper
警告!如果您使用
yarn 1
,您可能需要安装sharp
作为依赖项。
然后通过运行以下命令启动项目:
# install dependencies
npm run install
# start running the project
npm run dev
作为替代方法,如果您安装了 Docker,则可以使用 Docker 在本地运行该项目。方法如下:
# Build the Docker image
docker build -t astropaper .
# Run the Docker container
docker run -p 4321:80 astropaper
您可以使用环境变量轻松在 AstroPaper 中添加 Google 站点验证 HTML 标记。此步骤是可选的。如果您不添加以下环境变量,则 google-site-verification 标记将不会出现在 HTML <head>
部分中。
# in your environment variable file (.env)
PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value
请参阅此讨论,了解如何将 AstroPaper 添加到 Google Search Console。
所有命令都从项目的根目录的终端运行:
笔记!对于
Docker
命令,我们必须将其安装在您的计算机上。
命令 | 行动 |
---|---|
npm install | 安装依赖项 |
npm run dev | 在localhost:4321 启动本地开发服务器 |
npm run build | 将您的生产站点构建到./dist/ |
npm run preview | 在部署之前在本地预览您的构建 |
npm run format:check | 使用 Prettier 检查代码格式 |
npm run format | 使用 Prettier 设置代码格式 |
npm run sync | 为所有 Astro 模块生成 TypeScript 类型。了解更多。 |
npm run lint | 使用 ESLint 进行 Lint |
docker compose up -d | 在 docker 上运行 AstroPaper,您可以使用dev 命令通知的相同主机名和端口进行访问。 |
docker compose run app npm install | 您可以在 docker 容器中运行上面的任何命令。 |
docker build -t astropaper . | 为 AstroPaper 构建 Docker 镜像。 |
docker run -p 4321:80 astropaper | 在 Docker 上运行 AstroPaper。该网站可通过http://localhost:4321 访问。 |
警告!如果 Windows PowerShell 用户想要在开发期间运行诊断(
astro check --watch & astro dev
),则可能需要安装并发包。有关更多信息,请参阅此问题。
如果您有任何建议/反馈,可以通过我的电子邮件与我联系。或者,如果您发现错误或想要请求新功能,请随时提出问题。
根据 MIT 许可证获得许可,版权所有 © 2023
用?作者:Sat Naing ?? 和贡献者。