Skip to content

fix: landing pages syntax highlighting [internal] #1222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 30, 2024
Merged

fix: landing pages syntax highlighting [internal] #1222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
50857d0
fixed package json
webrdaniel Sep 20, 2024
94947c6
fix: use the default Docusaurus `CodeBlock` for the /api and /sdk pages
barjin Sep 25, 2024
aaa1867
chore: reset package-lock.json
barjin Sep 25, 2024
c5ebf2f
Merge branch 'master' of github.com:apify/apify-docs into fix/code-bl…
webrdaniel Oct 29, 2024
6185264
Styling of codeblock
webrdaniel Oct 30, 2024
e11f54e
Merge branch 'master' of github.com:apify/apify-docs into fix/code-bl…
webrdaniel Oct 30, 2024
b03e3bc
css cleaner formatting
webrdaniel Oct 30, 2024
8f4d864
fix selectors
webrdaniel Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions apify-docs-theme/src/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,9 @@ const themeConfig = ({
},
prism: {
defaultLanguage: 'typescript',
theme: require('prism-react-renderer').themes.github,
darkTheme: require('prism-react-renderer').themes.dracula,
additionalLanguages: ['docker', 'log', 'php', 'json5'],
theme: require('./theme/CodeThemes/light').lightTheme,
darkTheme: require('./theme/CodeThemes/dark').darkTheme,
additionalLanguages: ['docker', 'log', 'php', 'json5', 'bash'],
},
// this needs to be absolute link otherwise it gets resolved wrongly in project docs
image: 'https://apify.com/og-image/docs-article',
Expand Down
105 changes: 105 additions & 0 deletions apify-docs-theme/src/theme/CodeThemes/dark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
// Original: https://github.com/sdras/night-owl-vscode-theme

export const darkTheme = {
plain: {
color: '#d6deeb',
backgroundColor: '#252832',
},
styles: [
{
types: ['changed'],
style: {
color: 'rgb(162, 191, 252)',
fontStyle: 'italic',
},
},
{
types: ['deleted'],
style: {
color: 'rgba(239, 83, 80, 0.56)',
fontStyle: 'italic',
},
},
{
types: ['inserted', 'attr-name'],
style: {
color: 'rgb(173, 219, 103)',
fontStyle: 'italic',
},
},
{
types: ['comment'],
style: {
color: 'rgb(99, 119, 119)',
fontStyle: 'italic',
},
},
{
types: ['string', 'url'],
style: {
color: 'rgb(173, 219, 103)',
},
},
{
types: ['variable'],
style: {
color: 'rgb(214, 222, 235)',
},
},
{
types: ['number'],
style: {
color: 'rgb(247, 140, 108)',
},
},
{
types: ['builtin', 'char', 'constant', 'function'],
style: {
color: 'rgb(130, 170, 255)',
},
},
{
types: ['punctuation'],
style: {
color: 'rgb(199, 146, 234)',
},
},
{
types: ['selector', 'doctype'],
style: {
color: 'rgb(199, 146, 234)',
fontStyle: 'italic',
},
},
{
types: ['class-name'],
style: {
color: 'rgb(255, 203, 139)',
},
},
{
types: ['tag', 'operator', 'keyword'],
style: {
color: 'rgb(127, 219, 202)',
},
},
{
types: ['boolean'],
style: {
color: 'rgb(255, 88, 116)',
},
},
{
types: ['property'],
style: {
color: 'rgb(128, 203, 196)',
},
},
{
types: ['namespace'],
style: {
color: 'rgb(178, 204, 214)',
},
},
],
};
95 changes: 95 additions & 0 deletions apify-docs-theme/src/theme/CodeThemes/light.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
export const lightTheme = {
plain: {
color: 'black',
backgroundColor: '#f8f9fc',
},
styles: [
{
types: ['prolog', 'doctype', 'cdata'],
style: {
color: 'slategray',
},
},
{
types: ['punctuation'],
style: {
color: '#999',
},
},
{
types: ['namespace'],
style: {
opacity: 0.7,
},
},
{
types: ['property', 'tag', 'boolean', 'number', 'constant', 'symbol', 'deleted'],
style: {
color: '#905',
},
},
{
types: ['selector', 'attr-name', 'string', 'char', 'builtin', 'inserted'],
style: {
color: '#690',
},
},
{
types: ['operator', 'entity', 'url'],
style: {
color: '#9a6e3a',
backgroundColor: 'hsla(0, 0%, 100%, 0.5)',
},
},
{
types: ['atrule', 'attr-value', 'keyword'],
style: {
color: '#07a',
},
},
{
types: ['function', 'class-name'],
style: {
color: '#DD4A68',
},
},
{
types: ['comment'],
style: {
color: 'slategray',
fontStyle: 'italic',
},
},
{
types: ['regex'],
style: {
color: '#e90',
},
},
{
types: ['important'],
style: {
color: '#e90',
fontWeight: 'bold',
},
},
{
types: ['variable'],
style: {
color: '#e90',
},
},
{
types: ['bold'],
style: {
fontWeight: 'bold',
},
},
{
types: ['italic'],
style: {
fontStyle: 'italic',
},
},
],
};
23 changes: 22 additions & 1 deletion apify-docs-theme/src/theme/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1562,8 +1562,29 @@ html[data-theme='dark'] .runnable-code-block svg .apify-logo {
text-align: right;
min-width: 1.5rem;
display: inline-block;
opacity: .3;
left: var(--ifm-pre-padding);
color: var(--color-neutral-text-subtle);
}

.theme-code-block {
border-radius: 12px !important;
overflow: hidden;
border: 1px solid var(--color-neutral-border);
box-shadow: none !important;

div[class^="codeBlockTitle"]{
border-bottom: 1px solid var(--color-neutral-border) !important;
background: var(--color-neutral-background-subtle);
}

div[class^="buttonGroup"] button {
opacity: 1 !important;

&[title="Toggle word wrap"] {
display: none;
}
}

}

.redocusaurus table code {
Expand Down
11 changes: 8 additions & 3 deletions src/components/SdkSection/SdkSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { ActionLink, Button, CodeBlock, theme } from '@apify-packages/ui-library';
import { ActionLink, Button, theme } from '@apify-packages/ui-library';
import { useColorMode } from '@docusaurus/theme-common';
import useBaseUrl from '@docusaurus/useBaseUrl';
import CodeBlock from '@theme/CodeBlock';
import ThemedImage from '@theme/ThemedImage';
import React from 'react';
import GitHubButton from 'react-github-btn';
Expand Down Expand Up @@ -111,8 +112,12 @@ export default function SdkSection({
</div>
</div>
<div className="SdkSectionCodeExamples">
<CodeBlock language="bash" content={installCodeSnippet} fullHeight />
<CodeBlock language={lowerCaseLanguage} hideLineNumbers content={exampleCodeSnippet} />
<CodeBlock language="bash">
{installCodeSnippet}
</CodeBlock>
<CodeBlock language={lowerCaseLanguage}>
{exampleCodeSnippet}
</CodeBlock>
</div>
</StyledSdkSection>
);
Expand Down
33 changes: 16 additions & 17 deletions src/pages/api/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ import {
ActionLink,
BlogArticle,
Button,
CodeBlock,
theme,
} from '@apify-packages/ui-library';
import Link from '@docusaurus/Link';
import useBaseUrl from '@docusaurus/useBaseUrl';
import CodeBlock from '@theme/CodeBlock';
import Layout from '@theme/Layout';
import ThemedImage from '@theme/ThemedImage';
import React from 'react';
Expand Down Expand Up @@ -136,8 +136,8 @@ export default function Api() {
</div>}
>
<ClientCodeWrapper>
<CodeBlock content={[{ key: 'cURL', label: 'cURL', language: 'bash', code: `
# Prepare Actor input
<CodeBlock title="cURL" language='bash'>
{`# Prepare Actor input
cat > input.json <<'EOF'
{
// Define the input in JSON here
Expand All @@ -151,7 +151,9 @@ curl "https://api.apify.com/v2/acts/username~actorname/runs?token=<YOUR_API_TOKE
-H 'Content-Type: application/json'

# Use the defaultDatasetId from response and pass it instead of <DATASET_ID>
curl "https://api.apify.com/v2/datasets/<DATASET_ID>/items?token=<YOUR_API_TOKEN>"` }]} hideBashPromptPrefixes hideLineNumbers defaultTabKey="cURL" />
curl "https://api.apify.com/v2/datasets/<DATASET_ID>/items?token=<YOUR_API_TOKEN>"`
}
</CodeBlock>
</ClientCodeWrapper>
</SectionWrapper>
<Section
Expand Down Expand Up @@ -184,12 +186,13 @@ curl "https://api.apify.com/v2/datasets/<DATASET_ID>/items?token=<YOUR_API_TOKEN
</div>}
>
<ClientCodeWrapper>
<CodeBlock content='npm install apify-client' language="bash"/>
<CodeBlock language="bash">
npm install apify-client
</CodeBlock>
<CodeBlock
language='javascript'
hideLineNumbers
content={`
// Easily run Actors, await them to finish using the convenient .call() method, and retrieve results from the resulting dataset.
// eslint-disable-next-line max-len
>{`// Easily run Actors, await them to finish using the convenient .call() method, and retrieve results from the resulting dataset.
const { ApifyClient } = require('apify-client');

const client = new ApifyClient({
Expand All @@ -200,8 +203,8 @@ const client = new ApifyClient({
const { defaultDatasetId } = await client.actor('john-doe/my-cool-actor').call();

// Fetches results from the actor's dataset.
const { items } = await client.dataset(defaultDatasetId).listItems();
`}/>
const { items } = await client.dataset(defaultDatasetId).listItems();`}
</CodeBlock>
</ClientCodeWrapper>
</SectionWrapper>
),
Expand All @@ -228,22 +231,18 @@ const { items } = await client.dataset(defaultDatasetId).listItems();
</div>}
>
<ClientCodeWrapper>
<CodeBlock content='pip install apify-client' language="bash"/>
<CodeBlock language="bash">pip install apify-client</CodeBlock>
<CodeBlock
className="codeBlock"
language='python'
hideLineNumbers
content={`
from apify_client import ApifyClient
>{`from apify_client import ApifyClient

apify_client = ApifyClient('MY-APIFY-TOKEN')

# Start an actor and wait for it to finish
actor_call = apify_client.actor('john-doe/my-cool-actor').call()

# Fetch results from the actor run's default dataset
dataset_items = apify_client.dataset(actor_call['defaultDatasetId']).list_items().items
`}/></ClientCodeWrapper>
dataset_items = apify_client.dataset(actor_call['defaultDatasetId']).list_items().items`}</CodeBlock></ClientCodeWrapper>
</SectionWrapper>
),
},
Expand Down