返回介绍

框架体验

发布于 2024-09-11 01:08:08 字数 2018 浏览 0 评论 0 收藏 0

mkdir Island && cd Island
pnpm init -y
pnpm i islandjs -S

在 package.json 中添加命令:

{
  "scripts": {
    "dev": "island dev docs",
    "build": "island build docs",
    "preview": "island start docs"
  },
}

接着可以新建 docs/.island/config.ts 配置文件:

import { defineConfig } from "islandjs";

export default defineConfig({
  themeConfig: {
    nav: [
      {
        text: "Home",
        link: "/",
      },
    ],
    sidebar: {
      "/": [
        {
          text: "文章列表",
          items: [
            {
              text: "Fresh",
              link: "/article/fresh",
            },
            {
              text: "Astro",
              link: "/article/astro",
            },
          ],
        },
      ],
    },
  },
});

这样就配置好了站点的导航栏和侧边栏。

然后添加首页内容,新建 docs/index.md:

---
pageType: home

hero:
  name: Island.js 模板
  text: React SSG 文档站
  tagline: 提供 React SSG 文档站模板
  image:
    src: /logo.png
    alt: Note
  actions:
    - theme: brand
      text: 点击查看
      link: /article/fresh
    - theme: alt
      text: GitHub
      link: https://github.com/sanyuan0704/island.js
features:
  - title: Feature 1
    details: Feature 1 的详细内容
    icon: 
  - title: Feature 2
    details: Feature 2 的详细内容
    icon: ‍
  - title: Feature 3
    details: Feature 3 的详细内容
    icon: ‍
---

直接访问根路由(/),就可以看到首页的效果出现了,并且点击按钮也能够正常地进行页面跳转,但还存在一个问题:图片资源并不能显示。

这是因为当前的图片路径 /logo.png 并不存在,新建 docs/public 目录,在里面加入 logo.png 图片,接着框架会自动在 public 目录寻找 logo.png,然后进行展示。

执行 pnpm build 来进行打包,产物会默认放到 docs/.island/dist 中。

打包完后,可以使用 pnpm preview 命令预览产物,可以看到如下的命令行信息:

> island start docs

Built site served at http://localhost:4173/

进入 http://localhost:4173/ 后,就可以查看生产环境下的页面内容了。

到目前为止,一个最基础的项目模板就被搭建起来了。

从头到尾没有编写一行前端组件或者样式的代码,仅仅通过少量的配置 + Markdown 内容,就把完整的页面呈现出来了。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文