Package Exports
- @actsis/docusaurus-theme
- @actsis/docusaurus-theme/dist/actsis-docusaurus-theme.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@actsis/docusaurus-theme) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Actsis Docusaurus theme
Este tema agrega anulaciones de estilo y nuevos componentes para crear páginas de proyecto basadas en Docusaurus.
To get started (WIP)
Crea un nuevo proyecto de Docusaurus (with the
classictheme!):npx create-docusaurus@latest my-website classicInstale el paquete del tema Actsis Docusaurus:
npm i @actsis/docusaurus-themeConfigurar Docusaurus:
Abra el archivo de configuración (
docusaurus.config.js)Edita tu
title,taglineyfaviconEdita la barra de navegación:
- Eliminar
titledel objetonavbar - Configure el
logoy lositemsdel menú (evite el anidamiento de varios niveles si es posible)
- Eliminar
Editar el pie de página
footer: { links: [ { title: 'Community', items: [ { label: '', href: 'https://...', icon: '', }, ... ], }, ], }
Nota: busque el
iconoen el componente Icono del paquete (también incluirá una lista en algún momento)Editar el
copyrightEn la parte superior del archivo agregue:
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
Agregue estos al final de la configuración, justo después de
copyright:prism: { theme: darkCodeTheme, }, colorMode: { defaultMode: 'light', disableSwitch: true, respectPrefersColorScheme: false, },
Anular algunos de los componentes predeterminados
Reemplazar el pie de página
Vaya a
src/themey cree una carpetaFooteren élCree un archivo
index.jscon los siguientes contenidos:import React from 'react'; import { useThemeConfig } from '@docusaurus/theme-common'; import { Footer as ActsisFooter } from '@actsis/docusaurus-theme'; function Footer() { const { footer } = useThemeConfig(); return ( <ActsisFooter footer={footer} /> ); } export default React.memo(Footer);
Reemplazar el contenido de la página de listado del blog.
Vaya a
src/themey cree una carpetaBlogListPageen ellaCree un archivo
index.jscon los siguientes contenidos:import React from 'react'; import clsx from 'clsx'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import { PageMetadata, HtmlClassNameProvider, ThemeClassNames, } from '@docusaurus/theme-common'; import BlogLayout from '@theme/BlogLayout'; import BlogListPaginator from '@theme/BlogListPaginator'; import SearchMetadata from '@theme/SearchMetadata'; import BlogPostItems from '@theme/BlogPostItems'; import { EsOpenSource } from '../sections/os-projects'; import { EsOsFreebies } from '../sections/os-freebies'; function BlogListPageMetadata(props) { const { metadata } = props; const { siteConfig: { title: siteTitle }, } = useDocusaurusContext(); const { blogDescription, blogTitle, permalink } = metadata; const isBlogOnlyMode = permalink === '/'; const title = isBlogOnlyMode ? siteTitle : blogTitle; return ( <> <PageMetadata title={title} description={blogDescription} /> <SearchMetadata tag='blog_posts_list' /> </> ); } function BlogListPageContent(props) { const { metadata, items } = props; return ( <BlogLayout> <h1 className='es-big-title'>Typing as <wbr /> we code</h1> <div className='es-blog-grid'> <BlogPostItems items={items} /> </div> <BlogListPaginator metadata={metadata} /> <EsOpenSource gray /> <EsOsFreebies gray /> </BlogLayout> ); } export default function BlogListPage(props) { return ( <HtmlClassNameProvider className={clsx( ThemeClassNames.wrapper.blogPages, ThemeClassNames.page.blogListPage, )}> <BlogListPageMetadata {...props} /> <BlogListPageContent {...props} /> </HtmlClassNameProvider> ); }
(asegúrese de reemplazar cualquier contenido genérico aquí, como IconLinkCards)
- Reemplace las tarjetas de Admonition
- Vaya a
src/themey cree una carpetaAdmonitionen él - Cree un archivoindex.jscon los siguientes contenidos:jsx import React from 'react'; import { AdmonitionCard } from '@actsis/docusaurus-theme'; export default function Admonition(props) { return ( <AdmonitionCard {...props} /> ); }
- Cree su sitio
npm starty verifique todo
Componentes incorporados
Descripción más detallada próximamente
CtaCardsCtaImageButtonFeatureShowcaseHeroIconLinkCardsImageAndTextActsisLogoShowcaseCardTextCardsicons